Freeside:3:Documentation:Developer/FS/dsl note
From Freeside
Contents
NAME
FS::dsl_note - Object methods for dsl_note records
SYNOPSIS
use FS::dsl_note; $record = new FS::dsl_note \%hash; $record = new FS::dsl_note { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::dsl_note object represents a DSL order note. FS::dsl_note inherits from FS::Record. The following fields are currently supported:
- notenum - primary key; svcnum - the DSL for this note, see FS::svc_dsl; author - export-specific, e.g. note's author or ISP vs. telco/vendor; priority - export-specific, e.g. high priority or not; not used by most; _date - note date; note - the note
METHODS
- new HASHREF
- Creates a new note. To add the note 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 note. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
SEE ALSO
FS::Record, schema.html from the base documentation.