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

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

=head1 NAME

FS::qual_option - Object methods for qual_option records

=head1 SYNOPSIS

  use FS::qual_option;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::qual_option object represents a qualification option. 
FS::qual_option inherits from FS::Record.  The following fields are currently
supported:

=over 4

=item optionnum - primary key

=item qualnum - qualification (see L<FS::qual>)

=item optionname - option name

=item optionvalue - option value


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new qualification option. To add the qualification option 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 { 'qual_option'; }

=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 qualification option.  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('optionnum')
    || $self->ut_foreign_key('qualnum', 'qual', 'qualnum')
    || $self->ut_alpha('optionname')
    || $self->ut_textn('optionvalue')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

This doesn't do anything yet.

=head1 SEE ALSO

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

=cut

1;