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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ObstacleQuery can be retrieved from this session and mapped to this Map to create a virtual collection of Obstacles. The obstacle may be sequenced using the ObstacleSearchOrder from this session.

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

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

Gets an obstacle query.

Returnosid.mapping.path.ObstacleQuerythe obstacle query
CompliancemandatoryThis method must be implemented.
MethodgetObstacleSearchOrder
Description

Gets an obstacle search order.

Returnosid.mapping.path.ObstacleSearchOrderthe obstacle search order
CompliancemandatoryThis method must be implemented.
MethodapplyObstacleQuery
Description

Applies an obstacle query to this map.

Parametersosid.mapping.path.ObstacleQueryobstacleQuerythe obstacle query
ErrorsNULL_ARGUMENT obstacleQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED obstacleQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecObstacleQuery
Description

Gets an obstacle query inspector for this map.

Returnosid.mapping.path.ObstacleQueryInspectorthe obstacle query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyObstacleSequencing
Description

Applies an obstacle search order to this map.

Parametersosid.mapping.path.ObstacleSearchOrderobstacleSearchOrderthe obstacle search order
ErrorsNULL_ARGUMENT obstacleSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED obstacleSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObstacleQueryFromInspector
Description

Gets an obstacle query from an inspector.

Parametersosid.mapping.path.ObstacleQueryInspectorobstacleQueryInspectoran obstacle query inspector
Returnosid.mapping.path.ObstacleQuerythe obstacle query
ErrorsNULL_ARGUMENT obstacleQueryInspector is null
UNSUPPORTED obstacleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.