Freeside:3:Documentation:Developer/FS/alarm type

From Freeside
Jump to: navigation, search

NAME

FS::alarm_type - Object methods for alarm_type records

SYNOPSIS

 use FS::alarm_type;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::alarm_type object represents an alarm system type (number of inputs and outputs). FS::alarm_type inherits from FS::Record. The following fields are currently supported:

alarmtypenum
primary key
agentnum
agentnum
inputs
inputs
outputs
outputs
disabled
disabled

METHODS

new HASHREF
Creates a new type. To add the type 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 type. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
typename
inputs x outputs

BUGS

SEE ALSO

FS::svc_alarm, FS::Record