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

Latest revision as of 05:29, 10 February 2015

NAME

FS::circuit_provider - Object methods for circuit_provider records

SYNOPSIS

 use FS::circuit_provider;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::circuit_provider object represents a telecom carrier that provides physical circuits (FS::svc_circuit). FS::circuit_provider inherits from FS::Record. The following fields are currently supported:

providernum - primary key; provider - provider name; disabled - disabled

METHODS

new HASHREF

Creates a new record. To add the record 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