summaryrefslogtreecommitdiff
path: root/FS/FS/cust_category.pm
blob: 636b1d3de7f4e5dc7f510c332adabf45e2e4171f (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
package FS::cust_category;

use strict;
use base qw( FS::category_Common );
use FS::cust_class;

=head1 NAME

FS::cust_category - Object methods for cust_category records

=head1 SYNOPSIS

  use FS::cust_category;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::cust_category object represents a customer category.  Every customer
class (see L<FS::cust_class>) has, optionally, a customer category.
FS::cust_category inherits from FS::Record.  The following fields are currently
supported:

=over 4

=item categorynum

primary key

=item categoryname

Text name of this package category

=item weight

Weight

=item disabled

Disabled flag, empty or 'Y'

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new customer category.  To add the customer category to the database,
see L<"insert">.

=cut

sub table { 'cust_category'; }

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

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::cust_class>, L<FS::Record>

=cut

1;