Difference between revisions of "Freeside:3:Documentation:Developer/FS/part pkg usageprice"

Latest revision as of 06:34, 24 March 2015

NAME

FS::part_pkg_usageprice - Object methods for part_pkg_usageprice records

SYNOPSIS

 use FS::part_pkg_usageprice;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_usageprice object represents a usage pricing add-on. FS::part_pkg_usageprice inherits from FS::Record. The following fields are currently supported:

usagepricepart

primary key

pkgpart

pkgpart

price

price

currency

currency

action

action

target

target

amount

amount

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.

target_info

Returns a hash reference of information about the target of this object. Keys are "label" and "multiplier".

targets

(Class method) Returns a hash reference. Keys are possible values for the "target" field. Values are hash references with "label" and "multiplier" keys.

BUGS

SEE ALSO

FS::part_pkg, FS::Record