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