package categories (meta package classes) and grouping invoices by them

[freeside.git] / FS / FS / rate_detail.pm

diff --git a/FS/FS/rate_detail.pm b/FS/FS/rate_detail.pm
index 93b12f7..533fb1e 100644 (file)
--- a/FS/FS/rate_detail.pm
+++ b/FS/FS/rate_detail.pm
@@ -3,6 +3,9 @@ package FS::rate_detail;
 use strict;
 use vars qw( @ISA );
 use FS::Record qw( qsearch qsearchs );
 use strict;
 use vars qw( @ISA );
 use FS::Record qw( qsearch qsearchs );

+use FS::rate;
+use FS::rate_region;
+use Tie::IxHash;

 
 @ISA = qw(FS::Record);
 
 
 @ISA = qw(FS::Record);
 


@@ -32,6 +35,8 @@ inherits from FS::Record.  The following fields are currently supported:
 
 =over 4
 
 
 =over 4
 

+=item ratedetailnum - primary key
+

 =item ratenum - rate plan (see L<FS::rate>)
 
 =item orig_regionnum - call origination region
 =item ratenum - rate plan (see L<FS::rate>)
 
 =item orig_regionnum - call origination region


@@ -42,7 +47,7 @@ inherits from FS::Record.  The following fields are currently supported:
 
 =item min_charge - charge per minute
 
 
 =item min_charge - charge per minute
 

-=item sec_granularity - granularity in seconds, i.e. 6 or 60
+=item sec_granularity - granularity in seconds, i.e. 6 or 60; 0 for per-call

 
 =back
 
 
 =back
 


@@ -52,7 +57,8 @@ inherits from FS::Record.  The following fields are currently supported:
 
 =item new HASHREF
 
 
 =item new HASHREF
 

-Creates a new example.  To add the example to the database, see L<"insert">.
+Creates a new call plan rate.  To add the call plan rate to the database, see
+L<"insert">.

 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.
 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.


@@ -91,7 +97,7 @@ returns the error, otherwise returns false.
 
 =item check
 
 
 =item check
 

-Checks all fields to make sure this is a valid example.  If there is
+Checks all fields to make sure this is a valid call plan rate.  If there is

 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
 


@@ -104,11 +110,16 @@ sub check {
   my $self = shift;
 
   my $error = 
   my $self = shift;
 
   my $error = 

-       $self->ut_foreign_key('ratenum', 'rate', 'ratenum')
+       $self->ut_numbern('ratedetailnum')
+    || $self->ut_foreign_key('ratenum', 'rate', 'ratenum')

     || $self->ut_foreign_keyn('orig_regionnum', 'rate_region', 'regionnum' )
     || $self->ut_foreign_key('dest_regionnum', 'rate_region', 'regionnum' )
     || $self->ut_number('min_included')
     || $self->ut_foreign_keyn('orig_regionnum', 'rate_region', 'regionnum' )
     || $self->ut_foreign_key('dest_regionnum', 'rate_region', 'regionnum' )
     || $self->ut_number('min_included')

-    || $self->ut_money('min_charge')
+
+    #|| $self->ut_money('min_charge')
+    #good enough for now...
+    || $self->ut_float('min_charge')
+

     || $self->ut_number('sec_granularity')
   ;
   return $error if $error;
     || $self->ut_number('sec_granularity')
   ;
   return $error if $error;


@@ -116,6 +127,92 @@ sub check {
   $self->SUPER::check;
 }
 
   $self->SUPER::check;
 }
 

+=item rate 
+
+Returns the parent call plan (see L<FS::rate>) associated with this call plan
+rate.
+
+=cut
+
+sub rate {
+  my $self = shift;
+  qsearchs('rate', { 'ratenum' => $self->ratenum } );
+}
+
+=item orig_region 
+
+Returns the origination region (see L<FS::rate_region>) associated with this
+call plan rate.
+
+=cut
+
+sub orig_region {
+  my $self = shift;
+  qsearchs('rate_region', { 'regionnum' => $self->orig_regionnum } );
+}
+
+=item dest_region 
+
+Returns the destination region (see L<FS::rate_region>) associated with this
+call plan rate.
+
+=cut
+
+sub dest_region {
+  my $self = shift;
+  qsearchs('rate_region', { 'regionnum' => $self->dest_regionnum } );
+}
+
+=item dest_regionname
+
+Returns the name of the destination region (see L<FS::rate_region>) associated
+with this call plan rate.
+
+=cut
+
+sub dest_regionname {
+  my $self = shift;
+  $self->dest_region->regionname;
+}
+
+=item dest_regionname
+
+Returns a short list of the prefixes for the destination region
+(see L<FS::rate_region>) associated with this call plan rate.
+
+=cut
+
+sub dest_prefixes_short {
+  my $self = shift;
+  $self->dest_region->prefixes_short;
+}
+
+
+=back
+
+=head1 SUBROUTINES
+
+=over 4
+
+=item granularities
+
+  Returns an (ordered) hash of granularity => name pairs
+
+=cut
+
+tie my %granularities, 'Tie::IxHash',
+  '1', => '1 second',
+  '6'  => '6 second',
+  '30' => '30 second', # '1/2 minute',
+  '60' => 'minute',
+  '0'  => 'call',
+;
+
+sub granularities {
+  %granularities;
+}
+
+

 =back
 
 =head1 BUGS
 =back
 
 =head1 BUGS