Difference between revisions of "Freeside:3:Documentation:Developer/FS/circuit termination"

Latest revision as of 05:30, 10 February 2015

NAME

FS::circuit_termination - Object methods for circuit_termination records

SYNOPSIS

 use FS::circuit_termination;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::circuit_termination object represents a central office circuit interface type. FS::circuit_termination inherits from FS::Record. The following fields are currently supported:

termnum - primary key; termination - description of the termination type; disabled - 'Y' if this is disabled

METHODS

new HASHREF

Creates a new example. To add the example to the database, see "insert".

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.

SEE ALSO

FS::Record