FS/FS/cust_bill_pkg_display.pm

   1 package FS::cust_bill_pkg_display;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 @ISA = qw(FS::Record);
   8
   9 =head1 NAME
  10
  11 FS::cust_bill_pkg_display - Object methods for cust_bill_pkg_display records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_bill_pkg_display;
  16
  17   $record = new FS::cust_bill_pkg_display \%hash;
  18   $record = new FS::cust_bill_pkg_display { 'column' => 'value' };
  19
  20   $error = $record->insert;
  21
  22   $error = $new_record->replace($old_record);
  23
  24   $error = $record->delete;
  25
  26   $error = $record->check;
  27
  28 =head1 DESCRIPTION
  29
  30 An FS::cust_bill_pkg_display object represents line item display information.
  31 FS::cust_bill_pkg_display inherits from FS::Record.  The following fields are
  32 currently supported:
  33
  34 =over 4
  35
  36 =item billpkgdisplaynum
  37
  38 primary key
  39
  40 =item billpkgnum
  41
  42 billpkgnum
  43
  44 =item section
  45
  46 section
  47
  48 =cut
  49
  50 sub section {
  51   my ( $self, $value ) = @_;
  52   if ( defined($value) ) {
  53     $self->setfield('section', $value);
  54   } else {
  55     my $section = $self->getfield('section');
  56     unless ($section) {
  57       my $part_pkg = $self->cust_bill_pkg->part_pkg;
  58       $section = $part_pkg->categoryname if $part_pkg;
  59     }
  60     $section;
  61   }
  62 }
  63
  64 =item post_total
  65
  66 post_total
  67
  68 =item type
  69
  70 type
  71
  72 =item summary
  73
  74 summary
  75
  76 =back
  77
  78 =head1 METHODS
  79
  80 =over 4
  81
  82 =item new HASHREF
  83
  84 Creates a new line item display object.  To add the record to the database, see L<"insert">.
  85
  86 Note that this stores the hash reference, not a distinct copy of the hash it
  87 points to.  You can ask the object for a copy with the I<hash> method.
  88
  89 =cut
  90
  91 sub table { 'cust_bill_pkg_display'; }
  92
  93 =item insert
  94
  95 Adds this record to the database.  If there is an error, returns the error,
  96 otherwise returns false.
  97
  98 =cut
  99
 100 =item delete
 101
 102 Delete this record from the database.
 103
 104 =cut
 105
 106 =item replace OLD_RECORD
 107
 108 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 109 returns the error, otherwise returns false.
 110
 111 =cut
 112
 113 =item check
 114
 115 Checks all fields to make sure this is a valid line item display object.
 116 If there is an error, returns the error, otherwise returns false.  Called by
 117 the insert and replace methods.
 118
 119 =cut
 120
 121 sub check {
 122   my $self = shift;
 123
 124   my $error =
 125     $self->ut_numbern('billpkgdisplaynum')
 126     || $self->ut_number('billpkgnum')
 127     || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum')
 128     || $self->ut_textn('section')
 129     || $self->ut_enum('post_total', [ '', 'Y' ])
 130     || $self->ut_enum('type', [ '', 'S', 'R', 'U' ])
 131     || $self->ut_enum('summary', [ '', 'Y' ])
 132   ;
 133   return $error if $error;
 134
 135   $self->SUPER::check;
 136 }
 137
 138 =item cust_bill_pkg
 139
 140 Returns the associated cust_bill_pkg (see L<FS::cust_bill_pkg>) for this
 141 line item display object.
 142
 143 =cut
 144
 145 sub cust_bill_pkg {
 146   my $self = shift;
 147   qsearchs( 'cust_bill_pkg', { 'billpkgnum' => $self->billpkgnum } ) ;
 148 }
 149
 150 =back
 151
 152 =head1 BUGS
 153
 154
 155
 156 =head1 SEE ALSO
 157
 158 L<FS::Record>, L<FS::cust_bill_pkg>, schema.html from the base documentation.
 159
 160 =cut
 161
 162 1;
 163