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

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::alarm_system - Object methods for alarm_system records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::alarm_system;
 +
 +
  $record = new FS::alarm_system \%hash;
 +
  $record = new FS::alarm_system { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::alarm_system object represents an alarm system vendor. FS::alarm_system inherits from FS::Record. The following fields are currently supported:
 +
 +
; alarmsystemnum
 +
:primary key
 +
; agentnum
 +
:agentnum
 +
; systemname
 +
:systemname
 +
; disabled
 +
:disabled
 +
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new vendor. To add the vendor to the database, see [[#insert|"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 vendor. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
 +
==BUGS==
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/svc alarm|FS::svc_alarm]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]]

Latest revision as of 06:28, 10 February 2015

NAME

FS::alarm_system - Object methods for alarm_system records

SYNOPSIS

 use FS::alarm_system;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::alarm_system object represents an alarm system vendor. FS::alarm_system inherits from FS::Record. The following fields are currently supported:

alarmsystemnum
primary key
agentnum
agentnum
systemname
systemname
disabled
disabled

METHODS

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

BUGS

SEE ALSO

FS::svc_alarm, FS::Record

Retrieved from "http://www.freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/alarm_system&oldid=8302"