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