OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.Location
Implementsosid.OsidObject
osid.Federateable
Description

A Location represents a location in a Map.

MethodhasSpatialUnit
Description

Tests if a spatial unit is available for this location.

Returnboolean true if a spatial unit is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSpatialUnit
Description

Gets the spatial unit corresponding to this location.

Returnosid.mapping.SpatialUnitthe spatial unit for this location
ErrorsILLEGAL_STATE hasSpatialUnit() is false
CompliancemandatoryThis method must be implemented.
MethodgetLocationRecord
Description

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 .

Parametersosid.type.TypelocationRecordTypethe type of location record to retrieve
Returnosid.mapping.records.LocationRecordthe location record
ErrorsNULL_ARGUMENT locationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(locationRecordType) is false
CompliancemandatoryThis method must be implemented.