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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
package FS::agent;
use strict;
use vars qw(@ISA @EXPORT_OK);
use Exporter;
use FS::Record qw(fields qsearch qsearchs);
@ISA = qw(FS::Record Exporter);
@EXPORT_OK = qw(fields);
=head1 NAME
FS::agent - Object methods for agent records
=head1 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;
=head1 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:
=over 4
=item agemtnum - primary key (assigned automatically for new agents)
=item agent - Text name of this agent
=item typenum - Agent type. See L<FS::agent_type>
=item prog - For future use.
=item freq - For future use.
=back
=head1 METHODS
=over 4
=item create HASHREF
Creates a new agent. To add the agent to the database, see L<"insert">.
=cut
sub create {
my($proto,$hashref)=@_;
#now in FS::Record::new
#my($field);
#foreach $field (fields('agent')) {
# $hashref->{$field}='' unless defined $hashref->{$field};
#}
$proto->new('agent',$hashref);
}
=item insert
Adds this agent to the database. If there is an error, returns the error,
otherwise returns false.
=cut
sub insert {
my($self)=@_;
$self->check or
$self->add;
}
=item 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.
=cut
sub delete {
my($self)=@_;
return "Can't delete an agent with customers!"
if qsearch('cust_main',{'agentnum' => $self->agentnum});
$self->del;
}
=item replace OLD_RECORD
Replaces OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
sub replace {
my($new,$old)=@_;
return "(Old) Not an agent record!" unless $old->table eq "agent";
return "Can't change agentnum!"
unless $old->getfield('agentnum') eq $new->getfield('agentnum');
$new->check or
$new->rep($old);
}
=item 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.
=cut
sub check {
my($self)=@_;
return "Not a agent record!" unless $self->table eq "agent";
my($error)=
$self->ut_numbern('agentnum')
or $self->ut_text('agent')
or $self->ut_number('typenum')
or $self->ut_numbern('freq')
or $self->ut_textn('prog')
;
return $error if $error;
return "Unknown typenum!"
unless qsearchs('agent_type',{'typenum'=> $self->getfield('typenum') });
'';
}
=back
=head1 BUGS
It doesn't properly override FS::Record yet.
=head1 SEE ALSO
L<FS::Record>, L<FS::agent_type>, L<FS::cust_main>, schema.html from the base
documentation.
=head1 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
=cut
1;
|
