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 use FS::rate;
   7 use FS::rate_region;
   8
   9 @ISA = qw(FS::Record);
  10
  11 =head1 NAME
  12
  13 FS::rate_detail - Object methods for rate_detail records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::rate_detail;
  18
  19   $record = new FS::rate_detail \%hash;
  20   $record = new FS::rate_detail { 'column' => 'value' };
  21
  22   $error = $record->insert;
  23
  24   $error = $new_record->replace($old_record);
  25
  26   $error = $record->delete;
  27
  28   $error = $record->check;
  29
  30 =head1 DESCRIPTION
  31
  32 An FS::rate_detail object represents an call plan rate.  FS::rate_detail
  33 inherits from FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item ratedetailnum - primary key
  38
  39 =item ratenum - rate plan (see L<FS::rate>)
  40
  41 =item orig_regionnum - call origination region
  42
  43 =item dest_regionnum - call destination region
  44
  45 =item min_included - included minutes
  46
  47 =item min_charge - charge per minute
  48
  49 =item sec_granularity - granularity in seconds, i.e. 6 or 60
  50
  51 =back
  52
  53 =head1 METHODS
  54
  55 =over 4
  56
  57 =item new HASHREF
  58
  59 Creates a new call plan rate.  To add the call plan rate to the database, see
  60 L<"insert">.
  61
  62 Note that this stores the hash reference, not a distinct copy of the hash it
  63 points to.  You can ask the object for a copy with the I<hash> method.
  64
  65 =cut
  66
  67 # the new method can be inherited from FS::Record, if a table method is defined
  68
  69 sub table { 'rate_detail'; }
  70
  71 =item insert
  72
  73 Adds this record to the database.  If there is an error, returns the error,
  74 otherwise returns false.
  75
  76 =cut
  77
  78 # the insert method can be inherited from FS::Record
  79
  80 =item delete
  81
  82 Delete this record from the database.
  83
  84 =cut
  85
  86 # the delete method can be inherited from FS::Record
  87
  88 =item replace OLD_RECORD
  89
  90 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  91 returns the error, otherwise returns false.
  92
  93 =cut
  94
  95 # the replace method can be inherited from FS::Record
  96
  97 =item check
  98
  99 Checks all fields to make sure this is a valid call plan rate.  If there is
 100 an error, returns the error, otherwise returns false.  Called by the insert
 101 and replace methods.
 102
 103 =cut
 104
 105 # the check method should currently be supplied - FS::Record contains some
 106 # data checking routines
 107
 108 sub check {
 109   my $self = shift;
 110
 111   my $error =
 112        $self->ut_numbern('ratedetailnum')
 113     || $self->ut_foreign_key('ratenum', 'rate', 'ratenum')
 114     || $self->ut_foreign_keyn('orig_regionnum', 'rate_region', 'regionnum' )
 115     || $self->ut_foreign_key('dest_regionnum', 'rate_region', 'regionnum' )
 116     || $self->ut_number('min_included')
 117
 118     #|| $self->ut_money('min_charge')
 119     #good enough for now...
 120     || $self->ut_float('min_charge')
 121
 122     || $self->ut_number('sec_granularity')
 123   ;
 124   return $error if $error;
 125
 126   $self->SUPER::check;
 127 }
 128
 129 =item orig_region
 130
 131 Returns the origination region (see L<FS::rate_region>) associated with this
 132 call plan rate.
 133
 134 =cut
 135
 136 sub orig_region {
 137   my $self = shift;
 138   qsearchs('rate_region', { 'regionnum' => $self->orig_regionnum } );
 139 }
 140
 141 =item dest_region
 142
 143 Returns the destination region (see L<FS::rate_region>) associated with this
 144 call plan rate.
 145
 146 =cut
 147
 148 sub dest_region {
 149   my $self = shift;
 150   qsearchs('rate_region', { 'regionnum' => $self->dest_regionnum } );
 151 }
 152
 153 =back
 154
 155 =head1 BUGS
 156
 157 =head1 SEE ALSO
 158
 159 L<FS::rate>, L<FS::rate_region>, L<FS::Record>,
 160 schema.html from the base documentation.
 161
 162 =cut
 163
 164 1;
 165