Freeside:4:Documentation:Developer/FS/alarm station
From Freeside
Contents
NAME
FS::alarm_station - Object methods for alarm_station records
SYNOPSIS
use FS::alarm_station;
$record = new FS::alarm_station \%hash;
$record = new FS::alarm_station { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::alarm_station object represents an alarm system central station. FS::alarm_station inherits from FS::Record. The following fields are currently supported:
- alarmstationnum
- primary key
- agentnum
- agentnum
- stationname
- stationname
- disabled
- disabled
METHODS
- new HASHREF
- Creates a new central station. To add the central station 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 central station. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
