summaryrefslogtreecommitdiff
path: root/FS/FS/export_batch_item.pm
blob: e442748b54136c4137eef6aca9ecabb32c9d12cc (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::export_batch_item;

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

=head1 NAME

FS::export_batch_item - Object methods for export_batch_item records

=head1 SYNOPSIS

  use FS::export_batch_item;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::export_batch_item object represents a service change (insert, delete,
replace, suspend, unsuspend, or relocate) queued for processing by a 
batch-oriented export.

FS::export_batch_item inherits from FS::Record.  The following fields are
currently supported:

=over 4

=item itemnum

primary key

=item batchnum

L<FS::export_batch> foreign key; the batch that this item belongs to.

=item svcnum

L<FS::cust_svc> foreign key; the service that is being exported.

=item action

One of 'insert', 'delete', 'replace', 'suspend', 'unsuspend', or 'relocate'.

=item data

A place for the export to store data relating to the service change.

=item frozen

A flag indicating that C<data> is a base64-Storable encoded object rather
than a simple string.

=head1 METHODS

=over 4

=item new HASHREF

Creates a new batch item.  To add the example 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 { 'export_batch_item'; }

=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 example.  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('itemnum')
    || $self->ut_number('batchnum')
    || $self->ut_foreign_key('batchnum', 'export_batch', 'batchnum')
    || $self->ut_number('svcnum')
    || $self->ut_enum('action',
      [ qw(insert delete replace suspend unsuspend relocate) ]
    )
    || $self->ut_anything('data')
    || $self->ut_flag('frozen')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::export_batch>, L<FS::cust_svc>

=cut

1;