Freeside:3:Documentation:Developer/FS/part pkg currency

From Freeside
< Freeside:3:Documentation:Developer‎ | FS
Revision as of 07:34, 24 March 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_pkg_currency - Object methods for part_pkg_currency records

SYNOPSIS

 use FS::part_pkg_currency;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_currency object represents an example. FS::part_pkg_currency inherits from FS::Record. The following fields are currently supported:

pkgcurrencynum
primary key
pkgpart
Package definition (see FS::part_pkg).
currency
3-letter currency code
optionname
optionname
optionvalue
optionvalue

METHODS

new HASHREF
Creates a new example. To add the example 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 example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

The author forgot to customize this manpage.

SEE ALSO

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