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