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

This session manages queries and sequencing to create "smart" dynamic maps. An ObstacleEnablerQuery can be retrieved from this session and mapped to this Map to create a virtual collection of obstacle enablers. The obstacle enabler may be sequenced using the ObstacleEnablerSearchOrder from this session.

This Map has a default query that matches any obstacle enabler and a default search order that specifies no sequencing. The queries may be examined using an ObstacleEnablerQueryInspector. The query may be modified by converting the inspector back to an ObstacleEnablerQuery.

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

Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart map management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerQuery
Description

Gets an obstacle enabler query.

Returnosid.mapping.path.rules.ObstacleEnablerQuerythe obstacle enabler query
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerSearchOrder
Description

Gets an obstacle enabler search order.

Returnosid.mapping.path.rules.ObstacleEnablerSearchOrderthe obstacle enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyObstacleEnablerQuery
Description

Applies an obstacle enabler query to this map.

Parametersosid.mapping.path.rules.ObstacleEnablerQueryobstacleEnablerQuerythe obstacle enabler query
ErrorsNULL_ARGUMENT obstacleEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED obstacleEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectObstacleEnablerQuery
Description

Gets an obstacle enabler query inspector for this map.

Returnosid.mapping.path.rules.ObstacleEnablerQueryInspectorthe obstacle enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyObstacleEnablerSequencing
Description

Applies an obstacle enabler search order to this map.

Parametersosid.mapping.path.rules.ObstacleEnablerSearchOrderobstacleEnablerSearchOrderthe obstacle enabler search order
ErrorsNULL_ARGUMENT obstacleEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED obstacleEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObstacleEnablerQueryFromInspector
Description

Gets an obstacle enabler query from an inspector.

Parametersosid.mapping.path.rules.ObstacleEnablerQueryInspectorobstacleEnablerQueryInspectoran obstacle enabler query inspector
Returnosid.mapping.path.rules.ObstacleEnablerQuerythe obstacle enabler query
ErrorsNULL_ARGUMENT obstacleEnablerQueryInspector is null
UNSUPPORTED obstacleEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.