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

Latest revision as of 13:34, 27 June 2014

NAME

FS::export_batch_item - Object methods for export_batch_item records

SYNOPSIS

 use FS::export_batch_item;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::export_batch_item object represents a service change (insert, delete, replace, suspend, unsuspend, or relocate) queued for processing by a batch-oriented export.

FS::export_batch_item inherits from FS::Record. The following fields are currently supported:

itemnum

primary key

batchnum

FS::export_batch foreign key; the batch that this item belongs to.

svcnum

FS::cust_svc foreign key; the service that is being exported.

action

One of 'insert', 'delete', 'replace', 'suspend', 'unsuspend', or 'relocate'.

data

A place for the export to store data relating to the service change.

frozen

A flag indicating that data is a base64-Storable encoded object rather than a simple string.

METHODS

new HASHREF

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

BUGS

SEE ALSO

FS::export_batch, FS::cust_svc

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 62:

You forgot a '=back' before '=head1'