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

This session provides methods to retrieve Obstacle to Map mappings. An Obstacle may appear in multiple Map objects. Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupObstacleMapObstacles
Description

Tests if this user can perform lookups of obstacle/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeObstacleMapView
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.
MethodusePlenaryObstacleMapView
Description

A complete view of the Obstacle and Map 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.
MethodgetObstacleIdsByMap
Description

Gets the list of Obstacle Ids associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.id.IdListlist of related obstacle Ids
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesByMap
Description

Gets the list of Obstacles associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.mapping.path.ObstacleListlist of related obstacle
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstacleIdsByMaps
Description

Gets the list of Obstacle Ids corresponding to a list of Maps.

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.id.IdListlist of obstacle Ids
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesByMaps
Description

Gets the list of Obstacles corresponding to a list of Maps.

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.mapping.path.ObstacleListlist of obstacle
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapIdsByObstacle
Description

Gets the Map Ids mapped an an Obstacle.

Parametersosid.id.IdobstacleId Id of an Obstacle
Returnosid.id.IdListlist of maps
ErrorsNOT_FOUND obstacleId is not found
NULL_ARGUMENT obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsByObstacle
Description

Gets the Maps mapped to an Obstacle.

Parametersosid.id.IdobstacleId Id of an Obstacle
Returnosid.mapping.MapListlist of maps
ErrorsNOT_FOUND obstacleId is not found
NULL_ARGUMENT obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.