summaryrefslogtreecommitdiff
path: root/FS/FS/lata.pm
diff options
context:
space:
mode:
authorlevinse <levinse>2011-02-13 07:22:32 +0000
committerlevinse <levinse>2011-02-13 07:22:32 +0000
commite356f2ebb6564fe8d5333fc89bb4583ee3cd1fb1 (patch)
treeac286e1979c4aeecf41ea411fbba20b3aec555e9 /FS/FS/lata.pm
parent5226903b423e42e7e8ee135b2b445d362241102a (diff)
bulk DID orders and inventory, RT11291
Diffstat (limited to 'FS/FS/lata.pm')
-rw-r--r--FS/FS/lata.pm121
1 files changed, 121 insertions, 0 deletions
diff --git a/FS/FS/lata.pm b/FS/FS/lata.pm
new file mode 100644
index 0000000..7b42555
--- /dev/null
+++ b/FS/FS/lata.pm
@@ -0,0 +1,121 @@
+package FS::lata;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::lata - Object methods for lata records
+
+=head1 SYNOPSIS
+
+ use FS::lata;
+
+ $record = new FS::lata \%hash;
+ $record = new FS::lata { 'column' => 'value' };
+
+ $error = $record->insert;
+
+ $error = $new_record->replace($old_record);
+
+ $error = $record->delete;
+
+ $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::lata object represents a LATA number/name. FS::lata inherits from
+FS::Record. The following fields are currently supported:
+
+=over 4
+
+=item latanum
+
+primary key
+
+=item description
+
+description
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new LATA. To add the LATA to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to. You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'lata'; }
+
+=item insert
+
+Adds this record to the database. If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database. If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid LATA. If there is
+an error, returns the error, otherwise returns false. Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+ my $self = shift;
+
+ my $error =
+ $self->ut_numbern('latanum')
+ || $self->ut_text('description')
+ ;
+ return $error if $error;
+
+ $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+