<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::realestate_location

NAME

FS::realestate_location - Object representing a realestate_location record

SYNOPSIS

  use FS::realestate_location;

  $location = new FS::realestate_location \%values;
  $location = new FS::realestate_location {
    agentnum          => 1,
    location_title    => 'Superdome',
    address1          => '1500 Sugar Bowl Dr',
    city              => 'New Orleans',
    state             => 'LA',
    zip               => '70112',
  };

  $error = $location->insert;
  $error = $new_loc->replace($location);
  $error = $record->check;

  $error = $location->add_unit('Box Seat No. 42');
  @units = $location->units;

DESCRIPTION

An FS::realestate_location object represents a location for one or more FS::realestate_unit objects. Expected to contain at least one unit, as only realestate_unit objects are assignable to packages via FS::svc_realestate.

FS::realestate_location inherits from FS::Record.

The following fields are currently supported:

realestatelocnum
agentnum
location_title
address1 (optional)
address2 (optional)
city (optional)
state (optional)
zip (optional)
disabled

METHODS

new HASHREF (see FS::Record)
insert (see FS::Record)
delete
  FS::realestate_location records should never be deleted, only disabled
replace OLD_RECORD (see FS::Record)
check (see FS::Record)
agent

Returns the associated agent

add_unit UNIT_TITLE

Create an associated FS::realestate_unit record

units

Returns all units associated with this location

SUBROUTINES

SEE ALSO

FS::record, FS::realestate_unit, FS::svc_realestate

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 160:

You forgot a '=back' before '=head1'

<% include ('/elements/footer.html' ) %>