Difference between revisions of "Freeside:4:Documentation:Developer/FS/currency exchange"

Latest revision as of 07:18, 18 November 2015

NAME

FS::currency_exchange - Object methods for currency_exchange records

SYNOPSIS

 use FS::currency_exchange;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::currency_exchange object represents an exchange rate between currencies. FS::currency_exchange inherits from FS::Record. The following fields are currently supported:

currencyratenum

primary key

from_currency

from_currency

to_currency

to_currency

rate

rate

METHODS

new HASHREF

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

BUGS

SEE ALSO

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