OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.ResourceLocationSession
Implementsosid.OsidSession
Description

This session defines methods to look up resources on a map.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessResourceLocations
Description

Tests if this user can access the locations of resources. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer location operations to unauthorized users.

Returnboolean false if location methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeResourceLocationView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryResourceLocationView
Description

A complete view of the Location returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedMapView
Description

Federates the view for methods in this session. A federated view will include paths in maps which are children of this map in the map hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this map only.

CompliancemandatoryThis method is must be implemented.
MethodgetResourceLocation
Description

Gets the current closest bounding location of the given resource. The returned ResourceLocation may not indicate a known location if no location is known.

Parametersosid.id.IdresourceIda resource Id
Returnosid.mapping.ResourceLocationthe current location
ErrorsNOT_FOUND resourceId is not on map
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourceLocations
Description

Gets the current closest bounding locations of the given resources. In plenary mode, the returned list contains all of the locations of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.

Parametersosid.id.IdListresourceIdsa resource list
Returnosid.mapping.ResourceLocationListthe current locations
ErrorsNOT_FOUNDa resource Id is not on map
NULL_ARGUMENT resourceIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesAtLocation
Description

Gets the current resources at or within the given location.

Parametersosid.id.IdlocationIda location Id
Returnosid.mapping.ResourceLocationListthe resources at the location
ErrorsNOT_FOUND locationId not found
NULL_ARGUMENT locationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesAtLocationByGenusType
Description

Gets the current resources at or within the given location for a resource genus type.

Parametersosid.id.IdlocationIda location Id
osid.type.TyperesourceGenusTypea resource genus type
Returnosid.mapping.ResourceLocationListthe resources at the location
ErrorsNOT_FOUND locationId not found
NULL_ARGUMENT locationId or resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesAtSpatialUnit
Description

Gets the current resource within the given spatial unit.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
Returnosid.mapping.ResourceLocationListthe resources at the location
ErrorsNULL_ARGUMENT spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResourcesAtSpatialUnitByGenusType
Description

Gets the current resource within the given spatial unit for a given resource genus type.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
osid.type.TyperesourceGenusTypea resource genus type
Returnosid.mapping.ResourceLocationListthe resources at the location
ErrorsNULL_ARGUMENT spatialUnit or resourceGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.