1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
package FS::rate_detail;
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);
=head1 NAME
FS::rate_detail - Object methods for rate_detail records
=head1 SYNOPSIS
use FS::rate_detail;
$record = new FS::rate_detail \%hash;
$record = new FS::rate_detail { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::rate_detail object represents an call plan rate. FS::rate_detail
inherits from FS::Record. The following fields are currently supported:
=over 4
=item ratedetailnum - primary key
=item ratenum - rate plan (see L<FS::rate>)
=item orig_regionnum - call origination region
=item dest_regionnum - call destination region
=item min_included - included minutes
=item min_charge - charge per minute
=item sec_granularity - granularity in seconds, i.e. 6 or 60; 0 for per-call
=back
=head1 METHODS
=over 4
=item new HASHREF
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.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'rate_detail'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
# the insert method can be inherited from FS::Record
=item delete
Delete this record from the database.
=cut
# the delete method can be inherited from FS::Record
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
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.
=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('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_money('min_charge')
#good enough for now...
|| $self->ut_float('min_charge')
|| $self->ut_number('sec_granularity')
;
return $error if $error;
$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
=head1 SEE ALSO
L<FS::rate>, L<FS::rate_region>, L<FS::Record>,
schema.html from the base documentation.
=cut
1;
|