% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::inventory_class - Object methods for inventory_class records
use FS::inventory_class;
$record = new FS::inventory_class \%hash;
$record = new FS::inventory_class { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::inventory_class object represents a class of inventory, such as "DID numbers" or "physical equipment serials". FS::inventory_class inherits from FS::Record. The following fields are currently supported:
Creates a new inventory class. To add the class 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.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid inventory class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the number of available (unused/unallocated) inventory items of this class (see FS::inventory_item).
Returns the number of used (allocated) inventory items of this class (see FS::inventory_class).
Returns the total number of inventory items of this class (see FS::inventory_class).
FS::inventory_item, FS::Record, schema.html from the base documentation.