% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::svc_circuit - Object methods for svc_circuit records
use FS::svc_circuit;
$record = new FS::svc_circuit \%hash;
$record = new FS::svc_circuit { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
An FS::svc_circuit object represents a telecom circuit service (other than an analog phone line, which is svc_phone, or a DSL Internet connection, which is svc_dsl). FS::svc_circuit inherits from FS::svc_IP_Mixin, FS::MAC_Mixin, and FS::svc_Common. The following fields are currently supported:
primary key; see also FS::cust_svc
circuit type (such as DS1, DS1-PRI, DS3, OC3, etc.); foreign key to FS::circuit_type.
circuit provider (telco); foreign key to FS::circuit_provider.
circuit termination type; foreign key to FS::circuit_termination
provider circuit ID string defined by the provider
the requested date for completion of the circuit order
the provider's committed date for completion of the circuit order
the provider's order number
the qualification number, if a qualification was performed
the order status: ACCEPTED, PENDING, COMPLETED, etc.
the IP address of the endpoint equipment, if any. This will be validated as an IP address but not assigned from managed address space or checked for uniqueness.
the MAC address of the endpoint.
internal circuit ID string
Creates a new circuit service. To add the record to the database, see "insert".
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Checks all fields to make sure this is a valid service. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the circuit ID.