diff options
Diffstat (limited to 'FS/FS/part_pkg_report_option.pm')
-rw-r--r-- | FS/FS/part_pkg_report_option.pm | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/FS/FS/part_pkg_report_option.pm b/FS/FS/part_pkg_report_option.pm new file mode 100644 index 0000000..16a4c98 --- /dev/null +++ b/FS/FS/part_pkg_report_option.pm @@ -0,0 +1,125 @@ +package FS::part_pkg_report_option; + +use strict; +use base qw( FS::Record ); +use FS::Record qw( qsearch qsearchs ); + +=head1 NAME + +FS::part_pkg_report_option - Object methods for part_pkg_report_option records + +=head1 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; + +=head1 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: + +=over 4 + +=item num + +primary key + +=item name + +name - The name associated with the reporting option + +=item disabled + +disabled - set to 'Y' to prevent addition to new packages + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new report option. To add the option to the database, see L<"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 I<hash> method. + +=cut + +sub table { 'part_pkg_report_option'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +=item delete + +Delete this record from the database. + +=cut + +sub delete { + return "Can't delete part_pkg_report_option records!"; +} + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database. If there is an error, +returns the error, otherwise returns false. + +=cut + +=item 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. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('num') + || $self->ut_text('name') + || $self->ut_enum('disabled', [ '', 'Y' ]) + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +Overlaps somewhat with pkg_class and pkg_category + +=head1 SEE ALSO + +L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |