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