Freeside:3:Documentation:Developer/FS/cust contact

From Freeside
Jump to: navigation, search

NAME

FS::cust_contact - Object methods for cust_contact records

SYNOPSIS

 use FS::cust_contact;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_contact object represents a contact's attachment to a specific customer. FS::cust_contact inherits from FS::Record. The following fields are currently supported:

custcontactnum
primary key
custnum
custnum
contactnum
contactnum
classnum
classnum
comment
comment
selfservice_access
empty or Y

METHODS

new HASHREF
Creates a new record. To add the record 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 record. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
contact_classname
Returns the name of this contact's class (see FS::contact_class).

BUGS

SEE ALSO

FS::contact, FS::cust_main, FS::Record