Interface | osid.mapping.Location | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Federateable | |||
Description |
A | ||
Method | hasSpatialUnit | ||
Description |
Tests if a spatial unit is available for this location. | ||
Return | boolean | true if a spatial unit is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpatialUnit | ||
Description |
Gets the spatial unit corresponding to this location. | ||
Return | osid.mapping.SpatialUnit | the spatial unit for this location | |
Errors | ILLEGAL_STATE | hasSpatialUnit() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationRecord | ||
Description |
Gets the location record corresponding to the given
| ||
Parameters | osid.type.Type | locationRecordType | the type of location record to retrieve |
Return | osid.mapping.records.LocationRecord | the location record | |
Errors | NULL_ARGUMENT | locationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(locationRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |