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
|
package FS::quotation_pkg_discount;
use base qw( FS::pkg_discount_Mixin FS::Record );
use FS::Maketext 'mt'; # XXX not really correct
use strict;
=head1 NAME
FS::quotation_pkg_discount - Object methods for quotation_pkg_discount records
=head1 SYNOPSIS
use FS::quotation_pkg_discount;
$record = new FS::quotation_pkg_discount \%hash;
$record = new FS::quotation_pkg_discount { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::quotation_pkg_discount object represents a quotation package discount.
FS::quotation_pkg_discount inherits from FS::Record. The following fields are
currently supported:
=over 4
=item quotationpkgdiscountnum
primary key
=item quotationpkgnum
quotationpkgnum of the L<FS::quotation_pkg> record that this discount is
for.
=item discountnum
discountnum (L<FS::discount>)
=item setuprecur
Whether this is a setup or recur discount.
=item amount
Amount that will be discounted from either setup or recur fees, per package
quantity.
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new quotation package discount. To add the quotation package
discount 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 { 'quotation_pkg_discount'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Delete this record from the database.
=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.
=item check
Checks all fields to make sure this is a valid quotation package discount.
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('quotationpkgdiscountnum')
|| $self->ut_foreign_key('quotationpkgnum', 'quotation_pkg', 'quotationpkgnum' )
|| $self->ut_foreign_key('discountnum', 'discount', 'discountnum' )
|| $self->ut_enum('setuprecur', ['setup', 'recur'])
|| $self->ut_moneyn('amount')
;
return $error if $error;
$self->SUPER::check;
}
=back
=item description
Returns a string describing the discount (for use on the quotation).
=cut
sub description {
my $self = shift;
my $discount = $self->discount;
my $desc = $discount->description_short;
# XXX localize to prospect language, once prospects get languages
$desc .= mt(' each') if $self->quotation_pkg->quantity > 1;
if ($discount->months) {
# unlike cust_bill_pkg_discount, there are no "months remaining"; it
# hasn't started yet.
$desc .= mt(' (for [quant,_1,month])', $discount->months);
}
return $desc;
}
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
