Freeside:4:Documentation:Developer/FS/tower sector

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 07:31, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::tower_sector - Object methods for tower_sector records

SYNOPSIS

 use FS::tower_sector;

 $record = new FS::tower_sector \%hash;
 $record = new FS::tower_sector { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::tower_sector object represents an tower sector. FS::tower_sector inherits from FS::Record. The following fields are currently supported:

sectornum
primary key
towernum
towernum
sectorname
sectorname
ip_addr
ip_addr

METHODS

new HASHREF
Creates a new sector. To add the sector 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 sector. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
tower
Returns the tower for this sector, as an FS::tower object (see FS::tower).
description
Returns a description for this sector including tower name.
svc_broadband
Returns the services on this tower sector.

BUGS

SEE ALSO

FS::tower, FS::Record, schema.html from the base documentation.