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

Latest revision as of 20:05, 27 June 2012

NAME

FS::part_pkg_discount - Object methods for part_pkg_discount records

SYNOPSIS

 use FS::part_pkg_discount;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pkg_discount object represents a link from a package definition to a discount. This permits discounts for lengthened terms. FS::part_pkg_discount inherits from FS::Record. The following fields are currently supported:

pkgdiscountnum

primary key

pkgpart

pkgpart

discountnum

discountnum

METHODS

new HASHREF

Creates a new part_pkg_discount. 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.

discount

Returns the discount associated with this part_pkg_discount.

BUGS

SEE ALSO

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