Freeside:1.9:Documentation:Developer/FS/part pkg option

From Freeside
< Freeside:1.9:Documentation:Developer‎ | FS
Revision as of 16:50, 3 October 2007 by Ivan (talk | contribs) (import from POD)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::part_pkg_option - Object methods for part_pkg_option records

SYNOPSIS

 use FS::part_pkg_option;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_option object represents an package definition option. FS::part_pkg_option inherits from FS::Record. The following fields are currently supported:

optionnum - primary key; pkgpart - package definition (see FS::part_pkg); optionname - option name; optionvalue - option value

METHODS

new HASHREF
Creates a new package definition option. To add the package definition option to the database, see "insert"|#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 package definition option. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

Possibly.

SEE ALSO

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