Freeside:1.7:Documentation:Developer/FS/reason type
From Freeside
Contents
NAME
FS::reason_type - Object methods for reason_type records
SYNOPSIS
use FS::reason_type; $record = new FS::reason_type \%hash; $record = new FS::reason_type { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::reason_type object represents a grouping of reasons. FS::reason_type inherits from FS::Record. The following fields are currently supported:
- typenum - primary key; class - currently 'C', 'R', or 'S' for cancel, credit, or suspend; type - name of the type of reason
METHODS
- new HASHREF
- Creates a new reason_type. 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 reason_type. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
- reasons
- Returns a list of all reasons associated with this type.
- enabled_reasons
- Returns a list of enabled reasons associated with this type.
BUGS
Here be termintes. Don't use on wooden computers.
SEE ALSO
FS::Record, schema.html from the base documentation.