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 rated_seconds
  51
  52 =item rated_minutes
  53
  54 =item rated_granularity
  55
  56 =item status
  57
  58 status
  59
  60 =item svcnum
  61
  62 svc_phone record associated with this transaction, if there is one.
  63
  64 =back
  65
  66 =head1 METHODS
  67
  68 =over 4
  69
  70 =item new HASHREF
  71
  72 Creates a new record.  To add the record to the database, see L<"insert">.
  73
  74 Note that this stores the hash reference, not a distinct copy of the hash it
  75 points to.  You can ask the object for a copy with the I<hash> method.
  76
  77 =cut
  78
  79 # the new method can be inherited from FS::Record, if a table method is defined
  80
  81 sub table { 'cdr_termination'; }
  82
  83 =item insert
  84
  85 Adds this record to the database.  If there is an error, returns the error,
  86 otherwise returns false.
  87
  88 =cut
  89
  90 # the insert method can be inherited from FS::Record
  91
  92 =item delete
  93
  94 Delete this record from the database.
  95
  96 =cut
  97
  98 # the delete method can be inherited from FS::Record
  99
 100 =item replace OLD_RECORD
 101
 102 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 103 returns the error, otherwise returns false.
 104
 105 =cut
 106
 107 # the replace method can be inherited from FS::Record
 108
 109 =item check
 110
 111 Checks all fields to make sure this is a valid record.  If there is
 112 an error, returns the error, otherwise returns false.  Called by the insert
 113 and replace methods.
 114
 115 =cut
 116
 117 # the check method should currently be supplied - FS::Record contains some
 118 # data checking routines
 119
 120 sub check {
 121   my $self = shift;
 122
 123   my $error =
 124     $self->ut_numbern('cdrtermnum')
 125     || $self->ut_foreign_key('acctid', 'cdr', 'acctid')
 126     #|| $self->ut_foreign_key('termpart', 'part_termination', 'termpart')
 127     || $self->ut_number('termpart')
 128     || $self->ut_floatn('rated_price')
 129     || $self->ut_numbern('rated_seconds')
 130     || $self->ut_floatn('rated_minutes')
 131     || $self->ut_numbern('rated_granularity')
 132     || $self->ut_enum('status', [ '', 'processing-tiered', 'done' ] ) # , 'skipped' ] )
 133   ;
 134   return $error if $error;
 135
 136   $self->SUPER::check;
 137 }
 138
 139 #=item set_status_and_rated_price STATUS [ RATED_PRICE ]
 140 #
 141 #Sets the status to the provided string.  If there is an error, returns the
 142 #error, otherwise returns false.
 143 #
 144 #=cut
 145 #
 146 #sub set_status_and_rated_price {
 147 #  my($self, $status, $rated_price) = @_;
 148 #  $self->status($status);
 149 #  $self->rated_price($rated_price);
 150 #  $self->replace();
 151 #}
 152
 153 =back
 154
 155 =head1 BUGS
 156
 157 =head1 SEE ALSO
 158
 159 L<FS::cdr>, L<FS::Record>, schema.html from the base documentation.
 160
 161 =cut
 162
 163 1;
 164