5 use FS::Record qw( qsearch qsearchs );
9 @ISA = qw( FS::Record );
13 FS::agent - Object methods for agent records
19 $record = new FS::agent \%hash;
20 $record = new FS::agent { 'column' => 'value' };
22 $error = $record->insert;
24 $error = $new_record->replace($old_record);
26 $error = $record->delete;
28 $error = $record->check;
30 $agent_type = $record->agent_type;
32 $hashref = $record->pkgpart_hashref;
33 #may purchase $pkgpart if $hashref->{$pkgpart};
37 An FS::agent object represents an agent. Every customer has an agent. Agents
38 can be used to track things like resellers or salespeople. FS::agent inherits
39 from FS::Record. The following fields are currently supported:
43 =item agentnum - primary key (assigned automatically for new agents)
45 =item agent - Text name of this agent
47 =item typenum - Agent type. See L<FS::agent_type>
49 =item prog - For future use.
51 =item freq - For future use.
53 =item disabled - Disabled flag, empty or 'Y'
55 =item username - Username for the Agent interface
57 =item _password - Password for the Agent interface
67 Creates a new agent. To add the agent to the database, see L<"insert">.
71 sub table { 'agent'; }
75 Adds this agent to the database. If there is an error, returns the error,
76 otherwise returns false.
80 Deletes this agent from the database. Only agents with no customers can be
81 deleted. If there is an error, returns the error, otherwise returns false.
88 return "Can't delete an agent with customers!"
89 if qsearch( 'cust_main', { 'agentnum' => $self->agentnum } );
94 =item replace OLD_RECORD
96 Replaces OLD_RECORD with this one in the database. If there is an error,
97 returns the error, otherwise returns false.
101 Checks all fields to make sure this is a valid agent. If there is an error,
102 returns the error, otherwise returns false. Called by the insert and replace
111 $self->ut_numbern('agentnum')
112 || $self->ut_text('agent')
113 || $self->ut_number('typenum')
114 || $self->ut_numbern('freq')
115 || $self->ut_textn('prog')
117 return $error if $error;
119 if ( $self->dbdef_table->column('disabled') ) {
120 $error = $self->ut_enum('disabled', [ '', 'Y' ] );
121 return $error if $error;
124 if ( $self->dbdef_table->column('username') ) {
125 $error = $self->ut_alphan('username');
126 return $error if $error;
127 if ( length($self->username) ) {
128 my $conflict = qsearchs('agent', { 'username' => $self->username } );
129 return 'duplicate agent username (with '. $conflict->agent. ')'
131 $error = $self->ut_text('password'); # ut_text... arbitrary choice
133 $self->_password('');
137 return "Unknown typenum!"
138 unless $self->agent_type;
146 Returns the FS::agent_type object (see L<FS::agent_type>) for this agent.
152 qsearchs( 'agent_type', { 'typenum' => $self->typenum } );
155 =item pkgpart_hashref
157 Returns a hash reference. The keys of the hash are pkgparts. The value is
158 true if this agent may purchase the specified package definition. See
163 sub pkgpart_hashref {
165 $self->agent_type->pkgpart_hashref;
172 $Id: agent.pm,v 1.3.4.2 2003-09-30 15:01:42 ivan Exp $
178 L<FS::Record>, L<FS::agent_type>, L<FS::cust_main>, L<FS::part_pkg>,
179 schema.html from the base documentation.