summaryrefslogtreecommitdiff
path: root/FS/FS/sales_pkg_class.pm
blob: 0f85ac46ed90de28dca39608c632251a481a9636 (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
130
131
132
133
134
135
136
137
138
139
package FS::sales_pkg_class;
use base qw( FS::Commission_Mixin FS::Record );

use strict;

=head1 NAME

FS::sales_pkg_class - Object methods for sales_pkg_class records

=head1 SYNOPSIS

  use FS::sales_pkg_class;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::sales_pkg_class object represents a commission for a specific sales
person and package class.  FS::sales_pkg_class inherits from FS::Record.  The
following fields are currently supported:

=over 4

=item salespkgclassnum

primary key

=item salesnum

salesnum

=item classnum

classnum

=item commission_percent

commission_percent

=item commission_duration

commission_duration


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new record.  To add the record 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 { 'sales_pkg_class'; }

=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 record.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  $self->commission_percent(0) unless length($self->commission_percent);

  my $error = 
    $self->ut_numbern('salespkgclassnum')
    || $self->ut_foreign_key('salesnum', 'sales', 'salesnum')
    || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
    || $self->ut_float('commission_percent')
    || $self->ut_numbern('commission_duration')
  ;
  return $error if $error;

  $self->SUPER::check;
}

sub classname {
  my $self = shift;
  my $pkg_class = $self->pkg_class;
  $pkg_class ? $pkg_class->classname : '(no package class)';
}

sub cust_credit_search {
  my $self = shift;
  my $sales = $self->sales;
  $sales->cust_credit_search(@_, commission_classnum => $self->classnum);
}

sub cust_bill_pkg_search {
  my $self = shift;
  my $sales = $self->sales;
  $sales->cust_bill_pkg_search(@_, classnum => $self->classnum);
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::sales>, L<FS::pkg_class, L<FS::Record>.

=cut

1;