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
|
NAME
FS::agent_type - Object methods for agent_type records
SYNOPSIS
use FS::agent_type;
$record = create FS::agent_type \%hash;
$record = create FS::agent_type { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::agent_type object represents an agent type. Every agent
(see the FS::agent manpage) has an agent type. Agent types
define which packages (see the FS::part_pkg manpage) may be
purchased by customers (see the FS::cust_main manpage), via
FS::type_pkgs records (see the FS::type_pkgs manpage).
FS::agent_type inherits from FS::Record. The following fields
are currently supported:
typenum - primary key (assigned automatically for new agent types)
atype - Text name of this agent type
METHODS
create HASHREF
Creates a new agent type. To add the agent type to the
database, see the section on "insert".
insert
Adds this agent type to the database. If there is an error,
returns the error, otherwise returns false.
delete
Deletes this agent type from the database. Only agent types
with no agents 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 type.
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 manpage, the FS::type_pkgs
manpage, the FS::cust_main manpage, the FS::part_pkg manpage,
schema.html from the base documentation.
HISTORY
Class for the different sets of allowable packages you can
assign to an agent.
ivan@sisd.com 97-nov-13
ut_ FS::Record methods ivan@sisd.com 97-dec-10
Changed 'type' to 'atype' because Pg6.3 reserves the type word
bmccane@maxbaud.net 98-apr-3
pod, added check in delete ivan@sisd.com 98-sep-21
|
