summaryrefslogtreecommitdiff
path: root/FS/FS/queue_stat.pm
blob: c8e77913bcfc5e9b647cddfc2ffe6c13c125fca6 (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
129
package FS::queue_stat;
use base qw( FS::Record );

use strict;
#use FS::Record qw( qsearch qsearchs );

=head1 NAME

FS::queue_stat - Object methods for queue_stat records

=head1 SYNOPSIS

  use FS::queue_stat;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::queue_stat object represents statistcs about a completed (queued) job.
FS::queue_stat inherits from FS::Record.  The following fields are currently
supported:

=over 4

=item statnum

primary key

=item jobnum

jobnum

=item job

job

=item custnum

custnum

=item insert_date

insert_date

=item start_date

start_date

=item end_date

end_date

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new record.  To add the record 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

sub table { 'queue_stat'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=item delete

Delete this record from the database.

=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.

=item check

Checks all fields to make sure this is a valid record.  If there is
an error, returns the error, otherwise returns false.  Called by the insert
and replace methods.

=cut

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('statnum')
    || $self->ut_number('jobnum')
    || $self->ut_text('job')
    || $self->ut_numbern('custnum')
    || $self->ut_number('insert_date')
    || $self->ut_number('start_date')
    || $self->ut_number('end_date')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>

=cut

1;