=over 4
-=item ratenum - primary key
+=item ratenum
+
+primary key
=item ratename
+Rate name
+
+=item agentnum
+
+Optional agent (see L<FS::agent>) for agent-virtualized rates.
+
+=item default_detailnum
+
+Optional rate detail to apply when a call doesn't match any region in the
+rate plan. If this is not set, the call will either be left unrated (though
+it may still be processed under a different pricing addon package), or be
+marked as 'skipped', or throw a fatal error, depending on the setting of
+the 'ignore_unrateable' package option.
+
+Deprecated; we now find the default detail by its lack of regionnum.
+
+=item
+
=back
=head1 METHODS
=cut
-# the check method should currently be supplied - FS::Record contains some
-# data checking routines
-
sub check {
my $self = shift;
my $error =
$self->ut_numbern('ratenum')
|| $self->ut_text('ratename')
+ #|| $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
+ || $self->ut_numbern('default_detailnum')
;
return $error if $error;
=item dest_detail REGIONNUM | RATE_REGION_OBJECTD | HASHREF
Returns the rate detail (see L<FS::rate_detail>) for this rate to the
-specificed destination, or the empty string if no rate can be found for
-the given destination.
+specificed destination. If no rate can be found, returns the default
+rate if there is one, and an empty string otherwise.
Destination can be specified as an FS::rate_detail object or regionnum
(see L<FS::rate_detail>), or as a hashref containing the following keys:
});
}
- return '' unless $rate_prefix;
+ if ( !$rate_prefix ) {
+ # then this call doesn't match any known region; just return the
+ # appropriate anywhere rate
+ return $self->default_detail($cdrtypenum) || $self->default_detail('');
+ }
$regionnum = $rate_prefix->regionnum;
%hash,
'cdrtypenum' => $cdrtypenum
});
- # find all rates maching ratenum, regionnum and null cdrtypenum
+ # failing that, return the global default for this plan with the correct
+ # cdrtypenum (skips weektime processing)
+ if ( !@details and $cdrtypenum ) {
+ my $detail = $self->default_detail($cdrtypenum);
+ return $detail if $detail;
+ }
+ # failing that, find all rates maching ratenum, regionnum and null cdrtypenum
+ # (these can have weektime stuff)
if ( !@details and $cdrtypenum ) {
@details = qsearch( 'rate_detail', {
%hash,
foreach (@details) {
return $_ if $_->ratetimenum eq '';
}
- # found nothing
- return;
+ # if still nothing, return the global default rate for this plan
+ return $self->default_detail('');
}
=item rate_detail
qsearch( 'rate_detail', { 'ratenum' => $self->ratenum } );
}
+=item agent
+
+=cut
+
+sub agent {
+ my $self = shift;
+ eval "use FS::agent";
+ die $@ if $@;
+ qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
+}
=back
+=item default_detail [ CDRTYPENUM ]
+
+Returns the default rate detail for CDRTYPENUM (or for null CDR type, if not
+specified).
+
+=cut
+
+sub default_detail {
+ my $self = shift;
+ my $cdrtypenum = shift || '';
+# $self->default_detailnum ?
+# FS::rate_detail->by_key($self->default_detailnum) : ''
+ qsearchs( 'rate_detail', {
+ ratenum => $self->ratenum,
+ cdrtypenum => $cdrtypenum,
+ dest_regionnum => '',
+ orig_regionnum => '',
+ }) || '';
+}
+
=head1 SUBROUTINES
=over 4
warn "$rate replacing $old (". $param->{'ratenum'}. ")\n" if $DEBUG;
my @param = ( 'job'=>$job );
- push @param, 'rate_detail'=>\@rate_detail
- unless $param->{'preserve_rate_detail'};
+
+ $rate->default_detailnum($old->default_detailnum);
$error = $rate->replace( $old, @param );