Freeside:3:Documentation:Developer/FS/agent currency
From Freeside
Contents
NAME
FS::agent_currency - Object methods for agent_currency records
SYNOPSIS
use FS::agent_currency;
$record = new FS::agent_currency \%hash;
$record = new FS::agent_currency { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::agent_currency object represents an agent's ability to sell in a specific non-default currency. FS::agent_currency inherits from FS::Record. The following fields are currently supported:
- agentcurrencynum
- primary key
- agentnum
- Agent (see FS::agent)
- currency
- 3 letter currency code
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.
