Freeside:1.9:Documentation:Developer/FS/cust svc option
From Freeside
< Freeside:1.9:Documentation:Developer | FS
Revision as of 17:14, 6 February 2009 by Ivan (talk | contribs) (Edit via perl MediaWiki framework (1.13))
Contents
NAME
FS::cust_svc_option - Object methods for cust_svc_option records
SYNOPSIS
use FS::cust_svc_option; $record = new FS::cust_svc_option \%hash; $record = new FS::cust_svc_option { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::cust_svc_option object represents an customer service option. FS::cust_svc_option inherits from FS::Record. The following fields are currently supported:
- optionnum
- primary key
- svcnum
- svcnum (see FS::cust_svc)
- optionname
- Option Name
- optionvalue
- Option Value
METHODS
- new HASHREF
- Creates a new option. To add the option 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 option. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
BUGS
The author forgot to customize this manpage.
SEE ALSO
FS::Record, schema.html from the base documentation.