Freeside:4:Documentation:Developer/FS/qual option
From Freeside
< Freeside:4:Documentation:Developer | FS
Revision as of 07:27, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))
Contents
NAME
FS::qual_option - Object methods for qual_option records
SYNOPSIS
use FS::qual_option; $record = new FS::qual_option \%hash; $record = new FS::qual_option { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::qual_option object represents a qualification option. FS::qual_option inherits from FS::Record. The following fields are currently supported:
- optionnum - primary key; qualnum - qualification (see FS::qual); optionname - option name; optionvalue - option value
METHODS
- new HASHREF
- Creates a new qualification option. To add the qualification option 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 option. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
BUGS
This doesn't do anything yet.
SEE ALSO
FS::qual, FS::Record, schema.html from the base documentation.