Difference between revisions of "Freeside:3:Documentation:Developer/FS/part pop local"

Latest revision as of 20:05, 27 June 2012

NAME

FS::part_pop_local - Object methods for part_pop_local records

SYNOPSIS

 use FS::part_pop_local;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_pop_local object represents a local call area. Each FS::part_pop_local record maps a NPA/NXX (area code and exchange) to the POP (see FS::svc_acct_pop) which is a local call. FS::part_pop_local inherits from FS::Record. The following fields are currently supported:

localnum - primary key (assigned automatically for new accounts); popnum - see FS::svc_acct_pop; city; state; npa - area code; nxx - exchange

METHODS

new HASHREF

Creates a new point of presence (if only it were that easy!). To add the point of presence to the database, see "insert".

insert

Adds this point of presence to the database. If there is an error, returns the error, otherwise returns false.

delete

Removes this point of presence from the database.

replace OLD_RECORD

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

BUGS

US/CA-centric.

SEE ALSO

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