htdocs/docs/man/FS/agent.html

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