FS/FS/rate_prefix.pm

   1 package FS::rate_prefix;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs dbh );
   6 use FS::rate_region;
   7 use FS::lata;
   8
   9 @ISA = qw(FS::Record);
  10
  11 =head1 NAME
  12
  13 FS::rate_prefix - Object methods for rate_prefix records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::rate_prefix;
  18
  19   $record = new FS::rate_prefix \%hash;
  20   $record = new FS::rate_prefix { '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_prefix object represents an call rating prefix.  FS::rate_prefix
  33 inherits from FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item prefixnum - primary key
  38
  39 =item regionnum - call ration region (see L<FS::rate_region>)
  40
  41 =item countrycode
  42
  43 =item npa
  44
  45 =item nxx
  46
  47 =back
  48
  49 =head1 METHODS
  50
  51 =over 4
  52
  53 =item new HASHREF
  54
  55 Creates a new prefix.  To add the prefix 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_prefix'; }
  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 prefix.  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_numbern('prefixnum')
 108     || $self->ut_foreign_key('regionnum', 'rate_region', 'regionnum' )
 109     || $self->ut_number('countrycode')
 110     || $self->ut_numbern('npa')
 111     || $self->ut_numbern('nxx')
 112     || $self->ut_foreign_keyn('latanum', 'lata', 'latanum')
 113     || $self->ut_textn('state')
 114     || $self->ut_textn('ocn')
 115   ;
 116   return $error if $error;
 117
 118   $self->SUPER::check;
 119 }
 120
 121 =item rate_region
 122
 123 Returns the rate region (see L<FS::rate_region>) for this prefix.
 124
 125 =cut
 126
 127 sub rate_region {
 128   my $self = shift;
 129   qsearchs('rate_region', { 'regionnum' => $self->regionnum } );
 130 }
 131
 132 =back
 133
 134 =head1 CLASS METHODS
 135
 136 =over 4
 137
 138 =item all_countrycodes
 139
 140 Returns a list of all countrycodes listed in rate_prefix
 141
 142 =cut
 143
 144 sub all_countrycodes {
 145   #my $class = shift;
 146   my $sql =
 147     "SELECT DISTINCT(countrycode) FROM rate_prefix ORDER BY countrycode";
 148   my $sth = dbh->prepare($sql) or die  dbh->errstr;
 149   $sth->execute                or die $sth->errstr;
 150   map $_->[0], @{ $sth->fetchall_arrayref };
 151 }
 152
 153 =back
 154
 155 =head1 BUGS
 156
 157 =head1 SEE ALSO
 158
 159 L<FS::rate_region>, L<FS::Record>, schema.html from the base documentation.
 160
 161 =cut
 162
 163 1;
 164