Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/queue arg"
From Freeside
(import from POD) |
(import from POD) |
||
Line 23: | Line 23: | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
− | :Creates a new argument. To add the argument to the database, see [[ | + | :Creates a new argument. To add the argument to the database, see [[#insert|"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. | :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. |
Latest revision as of 17:26, 3 October 2007
Contents
NAME
FS::queue_arg - Object methods for queue_arg records
SYNOPSIS
use FS::queue_arg; $record = new FS::queue_arg \%hash; $record = new FS::queue_arg { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::queue_arg object represents job argument. FS::queue_arg inherits from FS::Record. The following fields are currently supported:
- argnum - primary key; jobnum - see FS::queue; arg - argument
METHODS
- new HASHREF
- Creates a new argument. To add the argument 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 argument. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
BUGS
SEE ALSO
FS::queue, FS::Record, schema.html from the base documentation.