Difference between revisions of "Freeside:4:Documentation:Developer/FS/cust note class"

Latest revision as of 07:20, 18 November 2015

NAME

FS::cust_note_class - Object methods for cust_note_class records

SYNOPSIS

 use FS::cust_note_class;

 $record = new FS::cust_note_class \%hash;
 $record = new FS::cust_note_class { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_note_class object represents a customer note class. Every customer note (see "FS::cust_main_note) has, optionally, a note class. This class inherits from FS::class_Common. The following fields are currently supported:"

classnum

primary key

classname

classname

disabled

disabled

METHODS

new HASHREF

Creates a new customer note class. To add the note class 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 class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::cust_main_note, FS::Record, schema.html from the base documentation.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 27:

Unterminated L<...> sequence