Interface Location

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Location
extends OsidObject, Federateable

A Location represents a location in a Map .

Method Summary

Modifier and Type	Method	Description
LocationRecord	getLocationRecord(Type locationRecordType)	Gets the location record corresponding to the given Location record Type .This method is used to retrieve an object implementing the requested record.
SpatialUnit	getSpatialUnit()	Gets the spatial unit corresponding to this location.
boolean	hasSpatialUnit()	Tests if a spatial unit is available for this location.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

hasSpatialUnit

boolean hasSpatialUnit()

Tests if a spatial unit is available for this location.

Returns:

true if a spatial unit is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSpatialUnit

SpatialUnit getSpatialUnit()

Gets the spatial unit corresponding to this location.

Returns:

the spatial unit for this location

Throws:

IllegalStateException - hasSpatialUnit() is false

Compliance:

mandatory - This method must be implemented.

getLocationRecord

LocationRecord getLocationRecord(Type locationRecordType)
                          throws OperationFailedException

Gets the location record corresponding to the given Location record Type .This method is used to retrieve an object implementing the requested record. The locationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(locationRecordType) is true .

Parameters:

locationRecordType - the type of location record to retrieve

Returns:

the location record

Throws:

NullArgumentException - locationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(locationRecordType) is false

Compliance:

mandatory - This method must be implemented.