Difference between revisions of "Freeside:4:Documentation:Developer/FS/hardware class"

Latest revision as of 07:23, 18 November 2015

NAME

FS::hardware_class - Object methods for hardware_class records

SYNOPSIS

 use FS::hardware_class;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::hardware_class object represents a class of hardware types which can be assigned to similar services (see FS::svc_hardware). FS::hardware_class inherits from FS::Record. The following fields are currently supported:

classnum - primary key; classname - classname

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

hardware_type

Returns all FS::hardware_type objects belonging to this class.

SEE ALSO

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