Freeside:4:Documentation:Developer/FS/hardware status

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 08:24, 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::hardware_status - Object methods for hardware_status records

SYNOPSIS

 use FS::hardware_status;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::hardware_status object represents an installation status for hardware services. FS::hardware_status inherits from FS::Record. The following fields are currently supported:

statusnum - primary key; label - descriptive label; disabled - 'Y' to disable

METHODS

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

SEE ALSO

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