Freeside:1.7:Documentation:Developer/FS/rate

From Freeside
Jump to: navigation, search

NAME

FS::rate - Object methods for rate records

SYNOPSIS

 use FS::rate;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

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

ratenum - primary key; ratename

METHODS

new HASHREF
Creates a new rate plan. To add the rate plan 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 [ , OPTION => VALUE ... ]
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Currently available options are: rate_detail
If rate_detail is set to an array reference of FS::rate_detail objects, the objects will have their ratenum field set and will be inserted after this record.
delete
Delete this record from the database.
replace OLD_RECORD [ , OPTION => VALUE ... ]
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Currently available options are: rate_detail
If rate_detail is set to an array reference of FS::rate_detail objects, the objects will have their ratenum field set and will be inserted after this record. Any existing rate_detail records associated with this record will be deleted.
check
Checks all fields to make sure this is a valid rate plan. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
dest_detail REGIONNUM | RATE_REGION_OBJECTD
Returns the rate detail (see FS::rate_detail) for this rate to the specificed destination.
rate_detail
Returns all region-specific details (see FS::rate_detail) for this rate.

SUBROUTINES

process
Experimental job-queue processor for web interface adds/edits

BUGS

SEE ALSO

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

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 370:
You forgot a '=back' before '=head1'