FS/FS/cust_bill_batch_option.pm

   1 package FS::cust_bill_batch_option;
   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_batch_option - Object methods for cust_bill_batch_option records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_bill_batch_option;
  16
  17   $record = new FS::cust_bill_batch_option \%hash;
  18   $record = new FS::cust_bill_batch_option { '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_batch_option object represents an option key and value for
  31 an invoice batch entry.  FS::cust_bill_batch_option inherits from
  32 FS::Record.  The following fields are currently supported:
  33
  34 =over 4
  35
  36 =item optionnum - primary key
  37
  38 =item billbatchnum -
  39
  40 =item optionname -
  41
  42 =item optionvalue -
  43
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item new HASHREF
  52
  53 Creates a new option.  To add the option to the database, see L<"insert">.
  54
  55 Note that this stores the hash reference, not a distinct copy of the hash it
  56 points to.  You can ask the object for a copy with the I<hash> method.
  57
  58 =cut
  59
  60 # the new method can be inherited from FS::Record, if a table method is defined
  61
  62 sub table { 'cust_bill_batch_option'; }
  63
  64 =item insert
  65
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68
  69 =cut
  70
  71 # the insert method can be inherited from FS::Record
  72
  73 =item delete
  74
  75 Delete this record from the database.
  76
  77 =cut
  78
  79 # the delete method can be inherited from FS::Record
  80
  81 =item replace OLD_RECORD
  82
  83 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  84 returns the error, otherwise returns false.
  85
  86 =cut
  87
  88 # the replace method can be inherited from FS::Record
  89
  90 =item check
  91
  92 Checks all fields to make sure this is a valid option.  If there is
  93 an error, returns the error, otherwise returns false.  Called by the insert
  94 and replace methods.
  95
  96 =cut
  97
  98 # the check method should currently be supplied - FS::Record contains some
  99 # data checking routines
 100
 101 sub check {
 102   my $self = shift;
 103
 104   my $error =
 105     $self->ut_numbern('optionnum')
 106     || $self->ut_foreign_key('billbatchnum', 'cust_bill_batch', 'billbatchnum')
 107     || $self->ut_text('optionname')
 108     || $self->ut_textn('optionvalue')
 109   ;
 110   return $error if $error;
 111
 112   $self->SUPER::check;
 113 }
 114
 115 =back
 116
 117 =head1 BUGS
 118
 119 =head1 SEE ALSO
 120
 121 L<FS::Record>, schema.html from the base documentation.
 122
 123 =cut
 124
 125 1;
 126