Freeside:3:Documentation:Developer/FS/circuit type

NAME

FS::circuit_type - Object methods for circuit_type records

SYNOPSIS

 use FS::circuit_type;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::circuit_type object represents a circuit type (such as "DS1" or "OC3"). FS::circuit_type inherits from FS::Record. The following fields are currently supported:

typenum - primary key; typename - name of the circuit 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