summaryrefslogtreecommitdiff
path: root/FS/FS/contact_class.pm
blob: 5fe2b38ed6dd4a3eb5ea297104b31ea61fb1cda4 (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
package FS::contact_class;
use base qw( FS::class_Common );

use strict;
use FS::Record qw( qsearch qsearchs );

=head1 NAME

FS::contact_class - Object methods for contact_class records

=head1 SYNOPSIS

  use FS::contact_class;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::contact_class object represents a contact class.  FS::contact_class
inherits from FS::class_Common.  The following fields are currently supported:

=over 4

=item classnum

primary key

=item classname

Class name

=item disabled

Disabled flag

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new example.  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 { 'contact_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 class.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=back

=head1 BUGS

The author forgot to customize this manpage.

=head1 SEE ALSO

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

=cut

1;