Freeside:3:Documentation:Developer/FS/lata
From Freeside
Contents
NAME
FS::lata - Object methods for lata records
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;
DESCRIPTION
An FS::lata object represents a LATA number/name. FS::lata inherits from FS::Record. The following fields are currently supported:
- latanum
- primary key
- description
- description
- have_usage - a reporting hack
METHODS
- new HASHREF
- Creates a new LATA. To add the LATA to the database, see "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 hash method.
- insert
- Adds this record to the database. If there is an error, returns the error, otherwise returns false.
- delete
- Delete this record from the database.
- replace OLD_RECORD
- Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
- 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.
SEE ALSO
FS::Record, schema.html from the base documentation.