summaryrefslogtreecommitdiff
path: root/FS/FS/hardware_type.pm
blob: 8324d7ce65631320d155b88ff0e0fac1ef565c1e (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
package FS::hardware_type;
use base qw( FS::Record );

use strict;

=head1 NAME

FS::hardware_type - Object methods for hardware_type records

=head1 SYNOPSIS

  use FS::hardware_type;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::hardware_type object represents a device type (a model name or 
number) assignable as a hardware service (L<FS::svc_hardware>).
FS::hardware_type inherits from FS::Record.  The following fields are 
currently supported:

=over 4

=item typenum - primary key

=item classnum - key to an L<FS::hardware_class> record defining the class 
to which this device type belongs.

=item model - descriptive model name or number

=item revision - revision name/number, subordinate to model

=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

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'hardware_type'; }

=item insert

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

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=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

# the replace method can be inherited from FS::Record

=item check

Checks all fields to make sure this is a valid hardware type.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

# the check method should currently be supplied - FS::Record contains some
# data checking routines

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('typenum')
    || $self->ut_foreign_key('classnum', 'hardware_class', 'classnum')
    || $self->ut_text('model')
    || $self->ut_textn('revision')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item hardware_class

Returns the L<FS::hardware_class> associated with this device.

=item description

Returns the model and revision number.

=cut

sub description {
  my $self = shift;
  $self->model . ($self->revision ? ' '.$self->revision : '');
}

=back

=head1 SEE ALSO

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

=cut

1;