public interface Location extends OsidObject, Federateable
A Location
represents a location in a Map.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
boolean hasSpatialUnit()
true
if a spatial unit is available,
false
otherwisemandatory
- This method must be implemented. SpatialUnit getSpatialUnit()
IllegalStateException
- hasSpatialUnit()
is false
mandatory
- This method must be implemented. LocationRecord getLocationRecord(Type locationRecordType) throws OperationFailedException
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
.locationRecordType
- the type of location record to retrieveNullArgumentException
- locationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(locationRecordType)
is false
mandatory
- This method must be implemented.