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

This session defines methods for retrieving obstacle.

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
  • isolated map view: All obstacle methods in this session operate, retrieve and pertain to obstacles defined explicitly in the current map. Using an isolated view is useful for managing Obstacles with the ObstacleAdminSession.
  • federated map view: All obstacle lookup methods in this session operate, retrieve and pertain to all obstacle defined in this map and any other obstacle implicitly available in this map through map inheritence.
  • active obstacle view: All obstacle lookup methods return active obstacles.
  • any status obstacle view: Obstacles of any active or inactive status are returned from methods.

The methods useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking any lookup methods.

Obstacles may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Obstacles.

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.
MethodcanLookupObstacles
Description

Tests if this user can perform Obstacle lookups. 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 lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeObstacleView
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.
MethodusePlenaryObstacleView
Description

A complete view of the Obstacle 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 obstacle 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.
MethoduseActiveObstacleView
Description

Only active obstacles are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusObstacleView
Description

All active and inactive obstacles are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetObstacle
Description

Gets the Obstacle specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Obstacle may have a different Id than requested, such as the case where a duplicate Id was assigned to an Obstacle and retained for compatibility.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.id.IdobstacleIdthe Id of the Obstacle to retrieve
Returnosid.mapping.path.Obstaclethe returned Obstacle
ErrorsNOT_FOUNDno Obstacle found with the given Id
NULL_ARGUMENT obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesByIds
Description

Gets an ObstacleList corresponding to the given IdList.

In plenary mode, the returned list contains all of the obstacles specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Obstacles may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.id.IdListobstacleIdsthe list of Ids to retrieve
Returnosid.mapping.path.ObstacleListthe returned Obstacle list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT obstacleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesByGenusType
Description

Gets an ObstacleList corresponding to the given obstacle genus Type which does not include obstacles of types derived from the specified Type.

In plenary mode, the returned list contains all known obstacles or an error obstacles Otherwise, the returned list may contain only those obstacles that are accessible through this session.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.type.TypeobstacleGenusTypean obstacle genus type
Returnosid.mapping.path.ObstacleListthe returned Obstacle list
ErrorsNULL_ARGUMENT obstacleGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesByParentGenusType
Description

Gets an ObstacleList corresponding to the given obstacle genus Type and include any additional obstacles with genus types derived from the specified Type.

In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.type.TypeobstacleGenusTypean obstacle genus type
Returnosid.mapping.path.ObstacleListthe returned Obstacle list
ErrorsNULL_ARGUMENT obstacleGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesByRecordType
Description

Gets an ObstacleList containing the given obstacle record Type.

In plenary mode, the returned list contains all known obstacle or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.type.TypeobstacleRecordTypean obstacle record type
Returnosid.mapping.path.ObstacleListthe returned Obstacle list
ErrorsNULL_ARGUMENT obstacleRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesForPath
Description

Gets an ObstacleList containing the given path.

In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.id.IdpathIda path Id
Returnosid.mapping.path.ObstacleListthe returned Obstacle list
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstaclesForPathAtCoordinate
Description

Gets an ObstacleList containing the given path between the given coordinates inclusive.

In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Parametersosid.id.IdpathIda path Id
osid.mapping.Coordinatecoordinatestarting coordinate
osid.mapping.Distancedistancea distance from coordinate
Returnosid.mapping.path.ObstacleListthe returned Obstacle list
ErrorsNULL_ARGUMENT pathId, coordinate or distance is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObstacles
Description

Gets all Obstacles.

In plenary mode, the returned list contains all known obstacles or an error results. Otherwise, the returned list may contain only those obstacles that are accessible through this session.

In active mode, obstacles are returned that are currently active. In any status mode, active and inactive obstacles are returned.

Returnosid.mapping.path.ObstacleLista list of Obstacles
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.