Difference between revisions of "Freeside:3:Documentation:Developer/FS/part pkg report option"

Latest revision as of 13:37, 27 June 2014

NAME

FS::part_pkg_report_option - Object methods for part_pkg_report_option records

SYNOPSIS

 use FS::part_pkg_report_option;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_report_option object represents a package definition optional reporting classification. FS::part_pkg_report_option inherits from FS::Record. The following fields are currently supported:

num

primary key

name

name - The name associated with the reporting option

disabled

disabled - set to 'Y' to prevent addition to new packages

METHODS

new HASHREF

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

CLASS METHODS

subsets OPTIONNUM, ...

Given a list of report_option numbers, determines all combinations of those numbers that exist on actual package definitions. For each such combination, returns an arrayref of report_option numbers, followed by an arrayref of corresponding report class names. This is used for a search optimization.

BUGS

Overlaps somewhat with pkg_class and pkg_category

SEE ALSO

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