oracle.panama.model
Interface LocationMark

All Superinterfaces:

Location, ModelObject, Point, java.io.Serializable, XMLObject

public interface LocationMark

extends ModelObject, Location

LocationMark is a named storage for an address. It is used to save the end user the efforts of typing address each time they want to use it as a parameter for a service for example.

Field Summary

static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier
static int	UNIT_KM
static int	UNIT_MILE

Method Summary

java.lang.String	getDescription()
int	getDistanceUnit() Get the distance unit of the radius of a region type location mark.
Location	getLocation() Get the location of the location mark.
Profile	getProfile()
int[]	getRegionIds() Get the ids of the regions of the location mark.
User	getUser()
boolean	hasGeometry() Check if the location mark has geometry or not.
boolean	isGeocoded() This function is for "point" type LocationMark only.
boolean	isPoint() Return true if location mark is a point.
boolean	isRegion() Return true if location mark is a region.
void	setDescription(java.lang.String description)
void	setDistanceUnit(int unit) Set the distance unit for the radius of a region type location mark.
void	setLocation(Location location) Set the location of the location mark.
void	setProfile(Profile profile)
void	setUser(User user)

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Methods inherited from interface oracle.panama.model.Location

geocode, getAddressLastLine, getAddressLine1, getAddressLine2, getBlock, getCity, getCompanyName, getCountry, getCounty, getGeocodeProvider, getMatchMode, getPostalCode, getPostalCodeExt, getState, setAddressLastLine, setAddressLine1, setAddressLine2, setBlock, setCity, setCompanyName, setCountry, setCounty, setGeocodeProvider, setMatchMode, setPostalCode, setPostalCodeExt, setState

Methods inherited from interface oracle.panama.model.Point

getDistance, getLabel, getLatitude, getLongitude, getPositionProvider, getRadius, setLabel, setLatitude, setLongitude, setPositionProvider, setRadius

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier

See Also:

Constant Field Values

TYPEID

public static final int TYPEID

The type id of this class.

See Also:

Constant Field Values

UNIT_MILE

public static final int UNIT_MILE

See Also:

Constant Field Values

UNIT_KM

public static final int UNIT_KM

See Also:

Constant Field Values

Method Detail

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getUser

public User getUser()

setUser

public void setUser(User user)

getProfile

public Profile getProfile()

setProfile

public void setProfile(Profile profile)
                throws PanamaException

PanamaException

hasGeometry

public boolean hasGeometry()

Check if the location mark has geometry or not. Return true if a "region" location mark has geometry or if a "point" location mark has longitude and latitude.

isGeocoded

public boolean isGeocoded()

This function is for "point" type LocationMark only. Return true if a "point" location mark has longitude and latitude. Otherwise return false.

isRegion

public boolean isRegion()

Return true if location mark is a region. Otherwise return false.

isPoint

public boolean isPoint()

Return true if location mark is a point. Otherwise return false.

getLocation

public Location getLocation()

Get the location of the location mark.

setLocation

public void setLocation(Location location)

Set the location of the location mark.

getDistanceUnit

public int getDistanceUnit()

Get the distance unit of the radius of a region type location mark.

Returns:

an integer whose value is either LocationMark.UNIT_MILE or UNIT_KM

setDistanceUnit

public void setDistanceUnit(int unit)

Set the distance unit for the radius of a region type location mark.

Parameters:

unit - An integer whose value is either LocationMark.UNIT_MILE or UNIT_KM

getRegionIds

public int[] getRegionIds()

Get the ids of the regions of the location mark. A location mark could consists of multiple regions, for example, Bay Area location mark consists San Franciso, San Jose and other Bay Area cities.