summaryrefslogtreecommitdiff
path: root/FS/FS/part_pkg_discount.pm
blob: 06a0fb97fa90590f6271685a1eda672390d4e805 (plain)
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
package FS::part_pkg_discount;

use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
use FS::discount;
use FS::part_pkg;

=head1 NAME

FS::part_pkg_discount - Object methods for part_pkg_discount records

=head1 SYNOPSIS

  use FS::part_pkg_discount;

  $record = new FS::part_pkg_discount \%hash;
  $record = new FS::part_pkg_discount { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_pkg_discount object represents a link from a package definition
to a discount.  This permits discounts for lengthened terms.  FS::part_pkg_discount inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item pkgdiscountnum

primary key

=item pkgpart

pkgpart

=item discountnum

discountnum


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new part_pkg_discount.  To add the example 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

sub table { 'part_pkg_discount'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=cut

=item delete

Delete this record from the database.

=cut

=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

=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('pkgdiscountnum')
    || $self->ut_number('pkgpart')
    || $self->ut_number('discountnum')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item discount

Returns the discount associated with this part_pkg_discount.

=cut

sub discount {
  my $self = shift;
  qsearchs('discount', { 'discountnum' => $self->discountnum });
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;