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

Latest revision as of 05:37, 10 February 2015

NAME

FS::part_pkg_fcc_option - Object methods for part_pkg_fcc_option records

SYNOPSIS

 use FS::part_pkg_fcc_option;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_fcc_option object represents an option that classifies a package definition on the FCC Form 477 report. FS::part_pkg_fcc_option inherits from FS::Record. The following fields are currently supported:

num

primary key

fccoptionname

A string identifying a report option, as an element of a static data structure found within this module. See the part method.

pkgpart

FS::part_pkg foreign key.

optionvalue

The value of the report option, as an integer. Boolean options use 1 and NULL. Most other options have some kind of lookup table.

METHODS

check

Checks all fields to make sure this is a valid FCC option. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

CLASS METHODS

media_types

Returns a Tie::IxHash hashref of the media type strings (which are not part of the report definition, per se) to arrayrefs of the technology codes included in each one.

technology_labels

Returns a hashref relating each technology code to a label. Unlike the media type strings, the technology codes are part of the formal report definition.

BUGS

SEE ALSO

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

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 171:

You forgot a '=back' before '=head1'