summaryrefslogtreecommitdiff
path: root/FS/FS/legacy_cust_history.pm
blob: e214d7241098e41e0dbd8590ca5d10c06339bf69 (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
130
131
132
133
134
package FS::legacy_cust_history;
use base qw( FS::Record );

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

=head1 NAME

FS::legacy_cust_history - Object methods for legacy_cust_history records

=head1 SYNOPSIS

  use FS::legacy_cust_history;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::legacy_cust_history object represents an item of customer change history
from a previous billing system.  FS::legacy_cust_history inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item legacyhistorynum

primary key

=item custnum

Customer (see L<FS::cust_main>)

=item history_action

Action, such as add, edit, delete, etc.

=item history_date

Date, as a UNIX timestamp

=item history_usernum

Employee (see L<FS::access_user>)

=item item

The item (i.e. table) which was changed.

=item description

A text description of the change

=item change_data

A text data structure representing the change

=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 { 'legacy_cust_history'; }

=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('legacyhistorynum')
    || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
    || $self->ut_text('history_action')
    || $self->ut_numbern('history_date')
    || $self->ut_foreign_keyn('history_usernum', 'access_user', 'usernum')
    || $self->ut_textn('item')
    || $self->ut_textn('description')
    || $self->ut_anything('change_data')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::Record>

=cut

1;