FS/FS/rate_detail.pm

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