search for missing/outdated census tract, RT#86245
[freeside.git] / FS / FS / part_svc_class.pm
1 package FS::part_svc_class;
2 use base qw( FS::class_Common );
3
4 use strict;
5 use FS::Record; # qw( qsearch qsearchs );
6
7 =head1 NAME
8
9 FS::part_svc_class - Object methods for part_svc_class records
10
11 =head1 SYNOPSIS
12
13   use FS::part_svc_class;
14
15   $record = new FS::part_svc_class \%hash;
16   $record = new FS::part_svc_class { 'column' => 'value' };
17
18   $error = $record->insert;
19
20   $error = $new_record->replace($old_record);
21
22   $error = $record->delete;
23
24   $error = $record->check;
25
26 =head1 DESCRIPTION
27
28 An FS::part_svc_class object represents a service class.  FS::part_svc_class
29 inherits from FS::Record.  The following fields are currently supported:
30
31 =over 4
32
33 =item classnum
34
35 primary key
36
37 =item classname
38
39 classname
40
41 =item disabled
42
43 disabled
44
45
46 =back
47
48 =head1 METHODS
49
50 =over 4
51
52 =item new HASHREF
53
54 Creates a new service class.  To add the service class to the database, see L<"insert">.
55
56 Note that this stores the hash reference, not a distinct copy of the hash it
57 points to.  You can ask the object for a copy with the I<hash> method.
58
59 =cut
60
61 # the new method can be inherited from FS::Record, if a table method is defined
62
63 sub table { 'part_svc_class'; }
64
65 =item insert
66
67 Adds this record to the database.  If there is an error, returns the error,
68 otherwise returns false.
69
70 =cut
71
72 # the insert method can be inherited from FS::Record
73
74 =item delete
75
76 Delete this record from the database.
77
78 =cut
79
80 # the delete method can be inherited from FS::Record
81
82 =item replace OLD_RECORD
83
84 Replaces the OLD_RECORD with this one in the database.  If there is an error,
85 returns the error, otherwise returns false.
86
87 =cut
88
89 # the replace method can be inherited from FS::Record
90
91 =item check
92
93 Checks all fields to make sure this is a valid service class.  If there is
94 an error, returns the error, otherwise returns false.  Called by the insert
95 and replace methods.
96
97 =cut
98
99 # the check method should currently be supplied - FS::Record contains some
100 # data checking routines
101
102 sub check {
103   my $self = shift;
104
105   my $error = 
106     $self->ut_numbern('classnum')
107     || $self->ut_text('classname')
108     || $self->ut_enum('disabled', [ '', 'Y' ] )
109   ;
110   return $error if $error;
111
112   $self->SUPER::check;
113 }
114
115 =back
116
117 =head1 BUGS
118
119 =head1 SEE ALSO
120
121 L<FS::Record>, schema.html from the base documentation.
122
123 =cut
124
125 1;
126