Difference between revisions of "Freeside:3:Documentation:Developer/FS/deploy zone block"

Latest revision as of 05:33, 10 February 2015

NAME

FS::deploy_zone_block - Object methods for deploy_zone_block records

SYNOPSIS

 use FS::deploy_zone_block;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::deploy_zone_block object represents a census block that's part of a deployment zone. FS::deploy_zone_block inherits from FS::Record. The following fields are currently supported:

blocknum

primary key

zonenum

FS::deploy_zone foreign key for the zone.

censusblock

U.S. census block number (15 digits).

censusyear

The year of the census map where the block appeared or was last verified.

METHODS

new HASHREF

Creates a new block entry. To add the recordto 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.

SEE ALSO

FS::Record