OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.ResourceLocation
Implementsosid.OsidCompendium
Description

This interface defines a resource at a location.

MethodgetResourceId
Description

Gets the Id of the resource on the route.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource on the route.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasLocation
Description

Tests if this resource has a known location.

Returnboolean true if a location is known, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLocationId
Description

Gets the location Id of the resource.

Returnosid.id.Idthe location Id
ErrorsILLEGAL_STATE hasLocation() is false
CompliancemandatoryThis method must be implemented.
MethodgetLocation
Description

Gets the location of the resource.

Returnosid.mapping.Locationthe location
ErrorsILLEGAL_STATE hasLocation() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasCoordinate
Description

Tests if this resource has a known coordinate.

Returnboolean true if a coordinate is known, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCoordinate
Description

Gets the coordinate of the resource.

Returnosid.mapping.Coordinatethe coordinate of the resource
ErrorsILLEGAL_STATE hasCoordinate() is false
CompliancemandatoryThis method must be implemented.
MethodgetResourceLocationRecord
Description

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

Parametersosid.type.TyperesourceLocationRecordTypethe type of resource location record to retrieve
Returnosid.mapping.records.ResourceLocationRecordthe resource location record
ErrorsNULL_ARGUMENT resourceLocationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resourceLocationRecordType) is false
CompliancemandatoryThis method must be implemented.