Freeside:4:Documentation:Developer/FS/svc cable

From Freeside
Jump to: navigation, search

NAME

FS::svc_cable - Object methods for svc_cable records

SYNOPSIS

 use FS::svc_cable;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::svc_cable object represents a cable subscriber. FS::svc_cable inherits from FS::Record. The following fields are currently supported:

svcnum
primary key

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.
label
Returns the MAC address and serial number.
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.
cable_provider
Returns the cable_provider object for this record.
cable_model
Returns the cable_model object for this record.

BUGS

SEE ALSO

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