Difference between revisions of "Freeside:3:Documentation:Developer/FS/qual"

Latest revision as of 20:06, 27 June 2012

NAME

FS::qual - Object methods for qual records

SYNOPSIS

 use FS::qual;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::qual object represents a qualification for service. FS::qual inherits from FS::Record. The following fields are currently supported:

qualnum - primary key; prospectnum; custnum; locationnum; phonenum - Service Telephone Number; exportnum - export instance providing service-qualification capabilities, see FS::part_export; vendor_qual_id - qualification id from vendor/telco; status - qualification status (e.g. (N)ew, (P)ending, (Q)ualifies)

METHODS

new HASHREF

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

SEE ALSO

FS::Record, schema.html from the base documentation.