summaryrefslogtreecommitdiff
path: root/site_perl/agent_type.pm
blob: 002c36f54a2f44cf4010d9257a3f8ff53e8ccf89 (plain)
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
package FS::agent_type;

use strict;
use vars qw(@ISA @EXPORT_OK);
use Exporter;
use FS::Record qw(qsearch fields);

@ISA = qw(FS::Record Exporter);
@EXPORT_OK = qw(fields);

=head1 NAME

FS::agent_type - Object methods for agent_type records

=head1 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;

=head1 DESCRIPTION

An FS::agent_type object represents an agent type.  Every agent (see
L<FS::agent>) has an agent type.  Agent types define which packages (see
L<FS::part_pkg>) may be purchased by customers (see L<FS::cust_main>), via 
FS::type_pkgs records (see L<FS::type_pkgs>).  FS::agent_type inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item typenum - primary key (assigned automatically for new agent types)

=item atype - Text name of this agent type

=back

=head1 METHODS

=over 4

=item create HASHREF

Creates a new agent type.  To add the agent type to the database, see
L<"insert">.

=cut

sub create {
  my($proto,$hashref)=@_;

  #now in FS::Record::new
  #my($field);
  #foreach $field (fields('agent_type')) {
  #  $hashref->{$field}='' unless defined $hashref->{$field};
  #}

  $proto->new('agent_type',$hashref);

}

=item insert

Adds this agent type 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 type from the database.  Only agent types with no agents
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_type with agents!"
    if qsearch('agent',{'typenum' => $self->typenum});
  $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 a agent_type record!" unless $old->table eq "agent_type";
  return "Can't change typenum!"   
    unless $old->getfield('typenum') eq $new->getfield('typenum');
  $new->check or
  $new->rep($old);
}

=item 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.

=cut

sub check {
  my($self)=@_;
  return "Not a agent_type record!" unless $self->table eq "agent_type";

  $self->ut_numbern('typenum')
  or $self->ut_text('atype');

}

=back

=head1 BUGS

It doesn't properly override FS::Record yet.

=head1 SEE ALSO

L<FS::Record>, L<FS::agent>, L<FS::type_pkgs>, L<FS::cust_main>,
L<FS::part_pkg>, schema.html from the base documentation.

=head1 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

=cut

1;