httemplate/docs/man/FS/agent_type.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::agent_type - Object methods for agent_type records</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#methods">METHODS</A></LI>
  18         <LI><A HREF="#version">VERSION</A></LI>
  19         <LI><A HREF="#bugs">BUGS</A></LI>
  20         <LI><A HREF="#see also">SEE ALSO</A></LI>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::agent_type - Object methods for agent_type records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::agent_type;</PRE>
  33 <PRE>
  34   $record = new FS::agent_type \%hash;
  35   $record = new FS::agent_type { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <PRE>
  45   $hashref = $record-&gt;pkgpart_hashref;
  46   #may purchase $pkgpart if $hashref-&gt;{$pkgpart};</PRE>
  47 <PRE>
  48   @type_pkgs = $record-&gt;type_pkgs;</PRE>
  49 <PRE>
  50   @pkgparts = $record-&gt;pkgpart;</PRE>
  51 <P>
  52 <HR>
  53 <H1><A NAME="description">DESCRIPTION</A></H1>
  54 <P>An FS::agent_type object represents an agent type.  Every agent (see
  55 <A HREF=".././FS/agent.html">the FS::agent manpage</A>) has an agent type.  Agent types define which packages (see
  56 <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>) may be purchased by customers (see <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>), via
  57 FS::type_pkgs records (see <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>).  FS::agent_type inherits from
  58 FS::Record.  The following fields are currently supported:</P>
  59 <DL>
  60 <DT><STRONG><A NAME="item_key">typenum - primary key (assigned automatically for new agent types)</A></STRONG><BR>
  61 <DD>
  62 <DT><STRONG><A NAME="item_atype_%2D_Text_name_of_this_agent_type">atype - Text name of this agent type</A></STRONG><BR>
  63 <DD>
  64 </DL>
  65 <P>
  66 <HR>
  67 <H1><A NAME="methods">METHODS</A></H1>
  68 <DL>
  69 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  70 <DD>
  71 Creates a new agent type.  To add the agent type to the database, see
  72 <A HREF="#insert">insert</A>.
  73 <P></P>
  74 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  75 <DD>
  76 Adds this agent type to the database.  If there is an error, returns the error,
  77 otherwise returns false.
  78 <P></P>
  79 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  80 <DD>
  81 Deletes this agent type from the database.  Only agent types with no agents
  82 can be deleted.  If there is an error, returns the error, otherwise returns
  83 false.
  84 <P></P>
  85 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  86 <DD>
  87 Replaces OLD_RECORD with this one in the database.  If there is an error,
  88 returns the error, otherwise returns false.
  89 <P></P>
  90 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  91 <DD>
  92 Checks all fields to make sure this is a valid agent type.  If there is an
  93 error, returns the error, otherwise returns false.  Called by the insert and
  94 replace methods.
  95 <P></P>
  96 <DT><STRONG><A NAME="item_pkgpart_hashref">pkgpart_hashref</A></STRONG><BR>
  97 <DD>
  98 Returns a hash reference.  The keys of the hash are pkgparts.  The value is
  99 true iff this agent may purchase the specified package definition.  See
 100 <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>.
 101 <P></P>
 102 <DT><STRONG><A NAME="item_type_pkgs">type_pkgs</A></STRONG><BR>
 103 <DD>
 104 Returns all FS::type_pkgs objects (see <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>) for this agent type.
 105 <P></P>
 106 <DT><STRONG><A NAME="item_pkgpart">pkgpart</A></STRONG><BR>
 107 <DD>
 108 Returns the pkgpart of all package definitions (see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>) for this
 109 agent type.
 110 <P></P></DL>
 111 <P>
 112 <HR>
 113 <H1><A NAME="version">VERSION</A></H1>
 114 <P>$Id: agent_type.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
 115 <P>
 116 <HR>
 117 <H1><A NAME="bugs">BUGS</A></H1>
 118 <P>
 119 <HR>
 120 <H1><A NAME="see also">SEE ALSO</A></H1>
 121 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/agent.html">the FS::agent manpage</A>, <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>,
 122 <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>, schema.html from the base documentation.</P>
 123
 124 </BODY>
 125
 126 </HTML>