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