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: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 - Object methods for agent records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::agent;</PRE>
  33 <PRE>
  34   $record = new FS::agent \%hash;
  35   $record = new FS::agent { '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   $agent_type = $record-&gt;agent_type;</PRE>
  46 <PRE>
  47   $hashref = $record-&gt;pkgpart_hashref;
  48   #may purchase $pkgpart if $hashref-&gt;{$pkgpart};</PRE>
  49 <P>
  50 <HR>
  51 <H1><A NAME="description">DESCRIPTION</A></H1>
  52 <P>An FS::agent object represents an agent.  Every customer has an agent.  Agents
  53 can be used to track things like resellers or salespeople.  FS::agent inherits
  54 from FS::Record.  The following fields are currently supported:</P>
  55 <DL>
  56 <DT><STRONG><A NAME="item_key">agemtnum - primary key (assigned automatically for new agents)</A></STRONG><BR>
  57 <DD>
  58 <DT><STRONG><A NAME="item_agent_%2D_Text_name_of_this_agent">agent - Text name of this agent</A></STRONG><BR>
  59 <DD>
  60 <DT><STRONG><A NAME="item_typenum_%2D_Agent_type%2E_See_FS%3A%3Aagent_type">typenum - Agent type.  See <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A></A></STRONG><BR>
  61 <DD>
  62 <DT><STRONG><A NAME="item_prog_%2D_For_future_use%2E">prog - For future use.</A></STRONG><BR>
  63 <DD>
  64 <DT><STRONG><A NAME="item_freq_%2D_For_future_use%2E">freq - For future use.</A></STRONG><BR>
  65 <DD>
  66 </DL>
  67 <P>
  68 <HR>
  69 <H1><A NAME="methods">METHODS</A></H1>
  70 <DL>
  71 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  72 <DD>
  73 Creates a new agent.  To add the agent to the database, see <A HREF="#insert">insert</A>.
  74 <P></P>
  75 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  76 <DD>
  77 Adds this agent to the database.  If there is an error, returns the error,
  78 otherwise returns false.
  79 <P></P>
  80 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  81 <DD>
  82 Deletes this agent from the database.  Only agents with no customers can be
  83 deleted.  If there is an error, returns the error, otherwise returns 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.  If there is an error,
  93 returns the error, otherwise returns false.  Called by the insert and replace
  94 methods.
  95 <P></P>
  96 <DT><STRONG><A NAME="item_agent_type">agent_type</A></STRONG><BR>
  97 <DD>
  98 Returns the FS::agent_type object (see <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A>) for this agent.
  99 <P></P>
 100 <DT><STRONG><A NAME="item_pkgpart_hashref">pkgpart_hashref</A></STRONG><BR>
 101 <DD>
 102 Returns a hash reference.  The keys of the hash are pkgparts.  The value is
 103 true if this agent may purchase the specified package definition.  See
 104 <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>.
 105 <P></P></DL>
 106 <P>
 107 <HR>
 108 <H1><A NAME="version">VERSION</A></H1>
 109 <P>$Id: agent.html,v 1.3 2001-04-23 12:40:30 ivan Exp $</P>
 110 <P>
 111 <HR>
 112 <H1><A NAME="bugs">BUGS</A></H1>
 113 <P>
 114 <HR>
 115 <H1><A NAME="see also">SEE ALSO</A></H1>
 116 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>, <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>,
 117 schema.html from the base documentation.</P>
 118
 119 </BODY>
 120
 121 </HTML>