Difference between revisions of "Freeside:3:Documentation:Developer/FS/inventory item"

Latest revision as of 20:04, 27 June 2012

NAME

FS::inventory_item - Object methods for inventory_item records

SYNOPSIS

 use FS::inventory_item;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::inventory_item object represents a specific piece of (real or virtual) inventory, such as a specific DID or serial number. FS::inventory_item inherits from FS::Record. The following fields are currently supported:

itemnum - primary key; classnum - Inventory class (see FS::inventory_class); item - Item identifier (unique within its inventory class); svcnum - Customer servcie (see FS::cust_svc)

METHODS

new HASHREF

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

cust_svc

Returns the customer service associated with this inventory item, if the item has been used (see FS::cust_svc).

agent

Returns the associated agent for this event, if any, as an FS::agent object.

SUBROUTINES

process_batch_import

BUGS

maybe batch_import should be a regular method in FS::inventory_class

SEE ALSO

inventory_class, cust_svc, FS::Record, schema.html from the base documentation.