Ivan: import from POD

2007-10-04T02:01:00Z

import from POD

New page

==NAME==
FS::queue_depend - Object methods for queue_depend records

==SYNOPSIS==
<code>
use FS::queue_depend;

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

$error = $record->insert;

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

$error = $record->delete;

$error = $record->check;
</code>
==DESCRIPTION==
An FS::queue_depend object represents an job dependancy. FS::queue_depend inherits from FS::Record. The following fields are currently supported:

; dependnum - primary key; jobnum - source jobnum (see [[Freeside:1.7:Documentation:Developer/FS/queue|FS::queue]]).; depend_jobnum - dependancy jobnum (see [[Freeside:1.7:Documentation:Developer/FS/queue|FS::queue]])
The job specified by '''jobnum''' depends on the job specified '''depend_jobnum''' - the '''jobnum''' job will not be run until the '''depend_jobnum''' job has completed successfully (or manually removed).

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

==BUGS==
==SEE ALSO==
[[Freeside:1.7:Documentation:Developer/FS/queue|FS::queue]], [[Freeside:1.7:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.

Freeside:1.7:Documentation:Developer/FS/queue depend - Revision history

Ivan: import from POD