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

NAME

FS::hardware_type - Object methods for hardware_type records

SYNOPSIS

 use FS::hardware_type;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::hardware_type object represents a device type (a model name or number) assignable as a hardware service (FS::svc_hardware)). FS::hardware_type inherits from FS::Record. The following fields are currently supported:

typenum - primary key; classnum - key to an FS::hardware_class record defining the class to which this device type belongs.; model - descriptive model name or number; revision - revision name/number, subordinate to model

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

hardware_class

Returns the FS::hardware_class associated with this device.

description

Returns the model and revision number.

SEE ALSO

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