Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/cust pkg reason"
From Freeside
(import from POD) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 23: | Line 23: | ||
==METHODS== | ==METHODS== | ||
; new HASHREF | ; new HASHREF | ||
| − | :Creates a new cust_pkg_reason. To add the example to the database, see [[ | + | :Creates a new cust_pkg_reason. To add the example to the database, see [[#insert|"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. | :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. | ||
| Line 34: | Line 34: | ||
; check | ; check | ||
:Checks all fields to make sure this is a valid cust_pkg_reason. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | :Checks all fields to make sure this is a valid cust_pkg_reason. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | ||
| + | ; reason | ||
| + | :Returns the reason (see [[Freeside:1.9:Documentation:Developer/FS/reason|FS::reason]]) associated with this cust_pkg_reason. | ||
| + | ; reasontext | ||
| + | :Returns the text of the reason (see [[Freeside:1.9:Documentation:Developer/FS/reason|FS::reason]]) associated with this cust_pkg_reason. | ||
==BUGS== | ==BUGS== | ||
Latest revision as of 17:14, 6 February 2009
Contents
NAME
FS::cust_pkg_reason - Object methods for cust_pkg_reason records
SYNOPSIS
use FS::cust_pkg_reason;
$record = new FS::cust_pkg_reason \%hash;
$record = new FS::cust_pkg_reason { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
DESCRIPTION
An FS::cust_pkg_reason object represents a relationship between a cust_pkg and a reason, for example cancellation or suspension reasons. FS::cust_pkg_reason inherits from FS::Record. The following fields are currently supported:
- num - primary key; pkgnum -; reasonnum -; otaker -; date -
METHODS
- new HASHREF
- Creates a new cust_pkg_reason. 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 cust_pkg_reason. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- reason
- Returns the reason (see FS::reason) associated with this cust_pkg_reason.
- reasontext
- Returns the text of the reason (see FS::reason) associated with this cust_pkg_reason.
BUGS
Here be termites. Don't use on wooden computers.
SEE ALSO
FS::Record, schema.html from the base documentation.
