org.osid.mapping

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

Methods

Modifier and Type	Method and Description
LocationRecord	getLocationRecord(Type locationRecordType) Gets the location record corresponding to the given Location record Type.
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 org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

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.