Difference between revisions of "Freeside:4:Documentation:Developer/FS/svc dsl"

Latest revision as of 07:30, 18 November 2015

NAME

FS::svc_dsl - Object methods for svc_dsl records

SYNOPSIS

 use FS::svc_dsl;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;
 
 $error = $record->suspend;

 $error = $record->unsuspend;

 $error = $record->cancel;

DESCRIPTION

An FS::svc_dsl object represents a DSL service. FS::svc_dsl inherits from FS::svc_Common. The following fields are currently supported:

svcnum - Primary key (assigned automatcially for new DSL)); pushed - Time DSL order pushed to vendor/telco, if applicable; desired_due_date - Desired Due Date; due_date - Due Date; vendor_order_id - Vendor/telco DSL order #; vendor_order_type

Vendor/telco DSL order type (e.g. (M)ove, (A)dd, (C)hange, (D)elete, or similar)

vendor_order_status

Vendor/telco DSL order status (e.g. (N)ew, (A)ssigned, (R)ejected, (M)revised, (C)ompleted, (X)cancelled, or similar)

first - End-user first name; last - End-user last name; company - End-user company name; phonenum - DSL Telephone Number; gateway_access_number - Gateway access number, if different; loop_type - Loop-type - vendor/telco-specific; local_voice_provider - Local Voice Provider's name; circuitnum - Circuit #; vpi; vci; rate_band - Rate Band; isp_chg; isp_prev; staticips; vendor_qual_id

Ikano-specific fields, do not use otherwise

username - if outsourced PPPoE/RADIUS, username; password - if outsourced PPPoE/RADIUS, password; monitored - Order is monitored (auto-pull/sync), either Y or blank; last_pull - time of last data pull from vendor/telco

METHODS

new HASHREF

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

notes

Returns the set of FS::dsl_notes associated with this service

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 DSL. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

gateway_access_or_phonenum; dsl_device

Returns the MAC addresses associated with this DSL service, as FS::dsl_device objects.

SEE ALSO

FS::svc_Common, edit/part_svc.cgi from an installed web interface, export.html from the base documentation, FS::Record, FS::Conf, FS::cust_svc, FS::part_svc, FS::cust_pkg, FS::queue, freeside-queued, schema.html from the base documentation.