Freeside:4:Documentation:Developer/FS/part fee msgcat

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 08:25, 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::part_fee_msgcat - Object methods for part_fee_msgcat records

SYNOPSIS

 use FS::part_fee_msgcat;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_fee_msgcat object represents localized labels of a fee definition. FS::part_fee_msgcat inherits from FS::Record. The following fields are currently supported:

feepartmsgnum
primary key
feepart - Fee definition (FS::part_fee); locale - locale string; itemdesc - Localized fee name (customer-viewable); comment - Localized fee comment (non-customer-viewable), optional

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

Exactly duplicates part_pkg_msgcat.pm.

SEE ALSO

FS::Record, schema.html from the base documentation.