3 <TITLE>FS::agent - Object methods for agent records</TITLE>
4 <LINK REV="made" HREF="mailto:none">
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>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::agent - Object methods for agent records
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
36 <PRE> $record = new FS::agent \%hash;
37 $record = new FS::agent { 'column' => 'value' };
40 <PRE> $error = $record->insert;
43 <PRE> $error = $new_record->replace($old_record);
46 <PRE> $error = $record->delete;
49 <PRE> $error = $record->check;
52 <PRE> $agent_type = $record->agent_type;
55 <PRE> $hashref = $record->pkgpart_hashref;
56 #may purchase $pkgpart if $hashref->{$pkgpart};
60 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
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:
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>
75 <H1><A NAME="METHODS">METHODS</A></H1>
77 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
79 Creates a new agent. To add the agent to the database, see <A HREF="#insert">insert</A>.
81 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
83 Adds this agent to the database. If there is an error, returns the error,
84 otherwise returns false.
86 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
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.
91 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
93 Replaces OLD_RECORD with this one in the database. If there is an error,
94 returns the error, otherwise returns false.
96 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
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
102 <DT><STRONG><A NAME="item_agent_type">agent_type</A></STRONG><DD>
104 Returns the FS::agent_type object (see <A HREF="../FS/agent_type.html">FS::agent_type</A>) for this agent.
106 <DT><STRONG><A NAME="item_pkgpart_hashref">pkgpart_hashref</A></STRONG><DD>
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>.
115 <H1><A NAME="VERSION">VERSION</A></H1>
117 $Id: agent.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
121 <H1><A NAME="BUGS">BUGS</A></H1>
124 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
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.