package FS::cust_bill_pkg_display; use base qw( FS::Record ); use strict; =head1 NAME FS::cust_bill_pkg_display - Object methods for cust_bill_pkg_display records =head1 SYNOPSIS use FS::cust_bill_pkg_display; $record = new FS::cust_bill_pkg_display \%hash; $record = new FS::cust_bill_pkg_display { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check; =head1 DESCRIPTION An FS::cust_bill_pkg_display object represents an instruction to display a line item in a specific invoice section. FS::cust_bill_pkg_display inherits from FS::Record and is many-to-one with FS::cust_bill_pkg (invoice line items). The following fields are currently supported: =over 4 =item billpkgdisplaynum - primary key =item billpkgnum - the line item number (L foreign key) =item section - the section name where this item should be shown. Defaults to the package category name, if there is one. =cut # actually it defaults to null, but then calling ->section will return the # category name. sub section { my ( $self, $value ) = @_; if ( defined($value) ) { $self->setfield('section', $value); } else { my $section = $self->getfield('section'); unless ($section) { my $cust_bill_pkg = $self->cust_bill_pkg; if ( $cust_bill_pkg->pkgnum > 0 && !$cust_bill_pkg->hidden ) { my $part_pkg = $cust_bill_pkg->part_pkg; $section = $part_pkg->categoryname if $part_pkg; } } $section; } } =item post_total - 'Y' to have this item shown in a "late" section (below the invoice totals). =item type - Which portion of the item's charges to show in the specified position. 'S' to show setup fees (including tax and one-time charge), 'R' to show the non-usage recurring charge, 'U' to show the usage charge, null to show all three as a single amount. =item summary - 'Y' to show a usage summary of this line item. This has the following effects if type = 'U': - The description will always be "Usage charges" rather than the package name. - Service labels and usage details (CDRs) are hidden. - It will only display on multisection invoices. =back =head1 METHODS =over 4 =item new HASHREF Creates a new line item display object. To add the record 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 method. =cut sub table { 'cust_bill_pkg_display'; } =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 =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 line item display object. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. =cut sub check { my $self = shift; my $error = $self->ut_numbern('billpkgdisplaynum') || $self->ut_number('billpkgnum') || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum') || $self->ut_textn('section') || $self->ut_enum('post_total', [ '', 'Y' ]) || $self->ut_enum('type', [ '', 'S', 'R', 'U' ]) || $self->ut_enum('summary', [ '', 'Y' ]) ; return $error if $error; $self->SUPER::check; } =item cust_bill_pkg Returns the associated cust_bill_pkg (see L) for this line item display object. =back =head1 BUGS =head1 SEE ALSO L, L, schema.html from the base documentation. =cut 1;