Difference between revisions of "Freeside:3:Documentation:Developer/FS/svc alarm"

Latest revision as of 13:39, 27 June 2014

NAME

FS::svc_alarm - Object methods for svc_alarm records

SYNOPSIS

 use FS::svc_alarm;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::svc_alarm object represents an alarm service. FS::svc_alarm inherits from FS::svc_Common.

The following fields are currently supported:

svcnum - Primary key; alarmsystemnum - Alarm System Vendor (see FS::alarm_system); alarmtypenum - Alarm System Type (inputs/outputs) (see FS::alarm_type); alarmstationnum - Alarm central station (see FS::alarm_station); acctnum - Account number; _password - Password; location - Location on property

METHODS

new HASHREF

Creates a new svc_dish object.

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 service. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

SEE ALSO

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