Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust main note"

Latest revision as of 20:04, 27 June 2012

NAME

FS::cust_main_note - Object methods for cust_main_note records

SYNOPSIS

 use FS::cust_main_note;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_main_note object represents a note attachted to a customer. FS::cust_main_note inherits from FS::Record. The following fields are currently supported:

notenum

primary key

custnum; classnum; _date; usernum; comments

METHODS

new HASHREF

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

cust_note_class

Returns the customer note class, as an FS::cust_note_class object, or the empty string if there is no note class.

classname

Returns the customer note class name, or the empty string if there is no customer note class.

BUGS

Lurking in the cracks.

SEE ALSO

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