Freeside:4:Documentation:Developer/FS/legacy cust history

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 07:24, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::legacy_cust_history - Object methods for legacy_cust_history records

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;

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:

legacyhistorynum
primary key
custnum
Customer (see FS::cust_main)
history_action
Action, such as add, edit, delete, etc.
history_date
Date, as a UNIX timestamp
history_usernum
Employee (see FS::access_user)
item
The item (i.e. table) which was changed.
description
A text description of the change
change_data
A text data structure representing the change

METHODS

new HASHREF
Creates a new record. To add the record to the database, see "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 hash method.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
delete
Delete this record from the database.
replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
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.

BUGS

SEE ALSO

FS::Record

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 40:
Unterminated L<...> sequence