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