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
|
NAME
FS::agent - Object methods for agent records
SYNOPSIS
use FS::agent;
$record = create FS::agent \%hash;
$record = create FS::agent { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
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:
agemtnum - primary key (assigned automatically for new agents)
agent - Text name of this agent
typenum - Agent type. See the FS::agent_type manpage
prog - For future use.
freq - For future use.
METHODS
create HASHREF
Creates a new agent. To add the agent to the database, see
the section on "insert".
insert
Adds this agent to the database. If there is an error,
returns the error, otherwise returns false.
delete
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.
replace OLD_RECORD
Replaces OLD_RECORD with this one in the database. If there
is an error, returns the error, otherwise returns false.
check
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.
BUGS
It doesn't properly override FS::Record yet.
SEE ALSO
the FS::Record manpage, the FS::agent_type manpage, the
FS::cust_main manpage, schema.html from the base documentation.
HISTORY
Class dealing with agent (resellers)
ivan@sisd.com 97-nov-13, 97-dec-10
pod, added check in ->delete ivan@sisd.com 98-sep-22
|
