Freeside:1.9:Documentation:Developer/FS/cust pkg detail

From Freeside
Jump to: navigation, search

NAME

FS::cust_pkg_detail - Object methods for cust_pkg_detail records

SYNOPSIS

 use FS::cust_pkg_detail;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_pkg_detail object represents additional customer package details. FS::cust_pkg_detail inherits from FS::Record. The following fields are currently supported:

pkgdetailnum
primary key
pkgnum
pkgnum (see FS::cust_pkg)
detail
detail
detailtype
"I" for Invoice details or "C" for comments
weight
Optional display weight

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::cust_pkg, FS::Record, schema.html from the base documentation.