Difference between revisions of "Freeside:4:Documentation:Developer/FS/phone avail"

Latest revision as of 07:27, 18 November 2015

NAME

FS::phone_avail - Phone number availability cache

SYNOPSIS

 use FS::phone_avail;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::phone_avail object represents availability of phone service. FS::phone_avail inherits from FS::Record. The following fields are currently supported:

availnum

primary key

exportnum

exportnum

countrycode

countrycode

state

state

npa

npa

nxx

nxx

station

station

name

Optional name

rate_center_abbrev - abbreviated rate center; latanum - LATA #; msanum - MSA #; ordernum - bulk DID order #; svcnum; availbatch

METHODS

new HASHREF

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

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

cust_svc; part_export; lata; msa2msanum

Translate free-form MSA name to a msa.msanum

BUGS

Sparse documentation.

SEE ALSO

FS::Record, schema.html from the base documentation.