FS/FS/cdr_termination.pm

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