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
|
package FS::part_pkg_usage;
use base qw( FS::m2m_Common FS::Record );
use strict;
use Scalar::Util qw(blessed);
=head1 NAME
FS::part_pkg_usage - Object methods for part_pkg_usage records
=head1 SYNOPSIS
use FS::part_pkg_usage;
$record = new FS::part_pkg_usage \%hash;
$record = new FS::part_pkg_usage { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::part_pkg_usage object represents a stock of usage minutes (generally
for voice services) included in a package definition. FS::part_pkg_usage
inherits from FS::Record. The following fields are currently supported:
=over 4
=item pkgusagepart - primary key
=item pkgpart - the package definition (L<FS::part_pkg>)
=item minutes - the number of minutes included per billing cycle
=item priority - the relative order in which to use this stock of minutes.
=item shared - 'Y' to allow these minutes to be shared with other packages
belonging to the same customer. Otherwise, only usage allocated to this
package will use this stock of minutes.
=item rollover - 'Y' to allow unused minutes to carry over between billing
cycles. Otherwise, the available minutes will reset to the value of the
"minutes" field upon billing.
=item description - a text description of this stock of minutes
=back
=head1 METHODS
=over 4
=item new HASHREF
=item insert CLASSES
=item replace CLASSES
CLASSES can be an array or hash of usage classnums (see L<FS::usage_class>)
to link to this record.
=item delete
=cut
sub table { 'part_pkg_usage'; }
sub insert {
my $self = shift;
my $opt = ref($_[0]) eq 'HASH' ? shift : { @_ };
$self->SUPER::insert
|| $self->process_m2m( 'link_table' => 'part_pkg_usage_class',
'target_table' => 'usage_class',
'params' => $opt,
);
}
sub replace {
my $self = shift;
my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
? shift
: $self->replace_old;
my $opt = ref($_[0]) eq 'HASH' ? $_[0] : { @_ };
$self->SUPER::replace($old)
|| $self->process_m2m( 'link_table' => 'part_pkg_usage_class',
'target_table' => 'usage_class',
'params' => $opt,
);
}
sub delete {
my $self = shift;
$self->process_m2m( 'link_table' => 'part_pkg_usage_class',
'target_table' => 'usage_class',
'params' => {},
) || $self->SUPER::delete;
}
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
sub check {
my $self = shift;
my $error =
$self->ut_numbern('pkgusagepart')
|| $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart')
|| $self->ut_float('minutes')
|| $self->ut_numbern('priority')
|| $self->ut_flag('shared')
|| $self->ut_flag('rollover')
|| $self->ut_textn('description')
;
return $error if $error;
$self->SUPER::check;
}
=item classnums
Returns the usage class numbers that are allowed to use minutes from this
pool.
=cut
sub classnums {
my $self = shift;
if (!$self->get('classnums')) {
my $classnums = [ map { $_->classnum } $self->part_pkg_usage_class ];
$self->set('classnums', $classnums);
}
@{ $self->get('classnums') };
}
=back
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
