Difference between revisions of "Freeside:4:Documentation:Developer/FS/export batch"
From Freeside
(Edit via perl MediaWiki framework (1.13)) |
(No difference)
|
Latest revision as of 07:22, 18 November 2015
Contents
NAME
FS::export_batch - Object methods for export_batch records
SYNOPSIS
use FS::export_batch;
$record = new FS::export_batch \%hash;
$record = new FS::export_batch { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::export_batch object represents a batch of records being processed by an export. This mechanism allows exports to process multiple pending service changes at the end of day or some other scheduled time, rather than doing everything in realtime or near-realtime (via the job queue).
FS::export_batch inherits from FS::Record. The following fields are currently supported:
- batchnum
- primary key
- exportnum
- The FS::part_export object that created this batch.
- _date
- The time the batch was created.
- status
- A status string. Allowed values are "open" (for a newly created batch that can receive additional items), "closed" (for a batch that is no longer allowed to receive items but is still being processed), "done" (for a batch that is finished processing), and "failed" (if there has been an error exporting the batch).
- statustext
- Free-text field for any status information from the remote machine or whatever else the export is doing. If status is "failed" this MUST contain a value.
METHODS
- new HASHREF
- Creates a new batch. 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. Don't ever do this.
- 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 batch. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
