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