RT# 77332 - Fixed error where all packages updated with new next bill date, instead...
[freeside.git] / FS / FS / lata.pm
1 package FS::lata;
2
3 use strict;
4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
6
7 =head1 NAME
8
9 FS::lata - Object methods for lata records
10
11 =head1 SYNOPSIS
12
13   use FS::lata;
14
15   $record = new FS::lata \%hash;
16   $record = new FS::lata { '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::lata object represents a LATA number/name.  FS::lata inherits from
29 FS::Record.  The following fields are currently supported:
30
31 =over 4
32
33 =item latanum
34
35 primary key
36
37 =item description
38
39 description
40
41 =item have_usage - a reporting hack
42
43 =back
44
45 =head1 METHODS
46
47 =over 4
48
49 =item new HASHREF
50
51 Creates a new LATA.  To add the LATA to the database, see L<"insert">.
52
53 Note that this stores the hash reference, not a distinct copy of the hash it
54 points to.  You can ask the object for a copy with the I<hash> method.
55
56 =cut
57
58 # the new method can be inherited from FS::Record, if a table method is defined
59
60 sub table { 'lata'; }
61
62 =item insert
63
64 Adds this record to the database.  If there is an error, returns the error,
65 otherwise returns false.
66
67 =cut
68
69 # the insert method can be inherited from FS::Record
70
71 =item delete
72
73 Delete this record from the database.
74
75 =cut
76
77 # the delete method can be inherited from FS::Record
78
79 =item replace OLD_RECORD
80
81 Replaces the OLD_RECORD with this one in the database.  If there is an error,
82 returns the error, otherwise returns false.
83
84 =cut
85
86 # the replace method can be inherited from FS::Record
87
88 =item check
89
90 Checks all fields to make sure this is a valid LATA.  If there is
91 an error, returns the error, otherwise returns false.  Called by the insert
92 and replace methods.
93
94 =cut
95
96 # the check method should currently be supplied - FS::Record contains some
97 # data checking routines
98
99 sub check {
100   my $self = shift;
101
102   my $error = 
103     $self->ut_numbern('latanum')
104     || $self->ut_text('description')
105     || $self->ut_numbern('have_usage')
106   ;
107   return $error if $error;
108
109   $self->SUPER::check;
110 }
111
112 sub _upgrade_data {  #class method
113   my ($class, %opts) = @_;
114   eval "use FS::lata_Data;"; # this automatically does the upgrade if needed
115 }
116
117 =back
118
119 =head1 SEE ALSO
120
121 L<FS::Record>, schema.html from the base documentation.
122
123 =cut
124
125 1;
126