Freeside:1.9:Documentation:Developer/FS/cust location

NAME

FS::cust_location - Object methods for cust_location records

SYNOPSIS

 use FS::cust_location;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cust_location object represents a customer location. FS::cust_location inherits from FS::Record. The following fields are currently supported:

locationnum

primary key

custnum

custnum

address1

Address line one (required)

address2

Address line two (optional)

city

City

county

County (optional, see FS::cust_main_county)

state

State (see FS::cust_main_county)

zip

Zip

country

Country (see FS::cust_main_county)

geocode

Geocode

METHODS

new HASHREF

Creates a new location. To add the location 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 location. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

country_full

Returns this locations's full country name

line

Returns this location on one line

BUGS

Not yet used for cust_main billing and shipping addresses.

SEE ALSO

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