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

use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch );
use FS::part_pkg;

@ISA = qw( FS::Record );

=head1 NAME

FS::pkg_class - Object methods for pkg_class records

=head1 SYNOPSIS

  use FS::pkg_class;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::pkg_class object represents an package class.  Every package definition
(see L<FS::part_pkg>) has, optionally, a package class. FS::pkg_class inherits
from FS::Record.  The following fields are currently supported:

=over 4

=item classnum - primary key (assigned automatically for new package classes)

=item classname - Text name of this package class

=item disabled - Disabled flag, empty or 'Y'

=back

=head1 METHODS

=over 4

=item new HASHREF

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

=cut

sub table { 'pkg_class'; }

=item insert

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

=item delete

Deletes this package class from the database.  Only package classes with no
associated package definitions can be deleted.  If there is an error, returns
the error, otherwise returns false.

=cut

sub delete {
  my $self = shift;

  return "Can't delete an pkg_class with part_pkg records!"
    if qsearch( 'part_pkg', { 'classnum' => $self->classnum } );

  $self->SUPER::delete;
}

=item replace OLD_RECORD

Replaces 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 package class.  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->ut_numbern('classnum')
  or $self->ut_text('classname')
  or $self->SUPER::check;

}

=back

=head1 BUGS

=head1 SEE ALSO

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

=cut

1;