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

Latest revision as of 21:04, 27 June 2012

NAME

FS::did_order_item - Object methods for did_order_item records

SYNOPSIS

 use FS::did_order_item;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::did_order_item object represents an item in a bulk DID order. FS::did_order_item inherits from FS::Record. The following fields are currently supported:

orderitemnum

primary key

ordernum; msanum - foreign key to msa table; npa; latanum - foreign key to lata table; ratecenternum - foreign key to rate_center table; state; quantity; custnum - foreign key to cust_main table, optional

METHODS

new HASHREF

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

rate_center

Returns the rate_center for this order item.

SEE ALSO

FS::did_order, <FS::Record>, schema.html from the base documentation.