ICS invoice spool format and email delivery, #17620
[freeside.git] / FS / FS / hardware_status.pm
1 package FS::hardware_status;
2
3 use strict;
4 use base qw( FS::Record );
5 use FS::Record qw( qsearch qsearchs );
6
7 =head1 NAME
8
9 FS::hardware_status - Object methods for hardware_status records
10
11 =head1 SYNOPSIS
12
13   use FS::hardware_status;
14
15   $record = new FS::hardware_status \%hash;
16   $record = new FS::hardware_status { 'column' => 'value' };
17
18   $error = $record->insert;
19
20   $error = $new_record->replace($old_record);
21
22   $error = $record->delete;
23
24   $error = $record->check;
25
26 =head1 DESCRIPTION
27
28 An FS::hardware_status object represents an installation status for hardware 
29 services.  FS::hardware_status inherits from FS::Record.  The following fields 
30 are currently supported:
31
32 =over 4
33
34 =item statusnum - primary key
35
36 =item label - descriptive label
37
38 =item disabled - 'Y' to disable
39
40 =back
41
42 =head1 METHODS
43
44 =over 4
45
46 =item new HASHREF
47
48 Creates a new record.  To add the record to the database, see L<"insert">.
49
50 Note that this stores the hash reference, not a distinct copy of the hash it
51 points to.  You can ask the object for a copy with the I<hash> method.
52
53 =cut
54
55 # the new method can be inherited from FS::Record, if a table method is defined
56
57 sub table { 'hardware_status'; }
58
59 =item insert
60
61 Adds this record to the database.  If there is an error, returns the error,
62 otherwise returns false.
63
64 =cut
65
66 # the insert method can be inherited from FS::Record
67
68 =item delete
69
70 Delete this record from the database.
71
72 =cut
73
74 # the delete method can be inherited from FS::Record
75
76 =item replace OLD_RECORD
77
78 Replaces the OLD_RECORD with this one in the database.  If there is an error,
79 returns the error, otherwise returns false.
80
81 =cut
82
83 # the replace method can be inherited from FS::Record
84
85 =item check
86
87 Checks all fields to make sure this is a valid status.  If there is
88 an error, returns the error, otherwise returns false.  Called by the insert
89 and replace methods.
90
91 =cut
92
93 # the check method should currently be supplied - FS::Record contains some
94 # data checking routines
95
96 sub check {
97   my $self = shift;
98
99   my $error = 
100     $self->ut_numbern('statusnum')
101     || $self->ut_text('label')
102     || $self->ut_enum('disabled', [ '', 'Y' ])
103   ;
104   return $error if $error;
105
106   $self->SUPER::check;
107 }
108
109 =back
110
111 =head1 SEE ALSO
112
113 L<FS::svc_hardware>, L<FS::Record>, schema.html from the base documentation.
114
115 =cut
116
117 1;
118