Interface | osid.mapping.path.rules.ObstacleEnablerSmartMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic maps. An This | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartMaps | ||
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 | ||
Return | boolean | false if smart map management is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerQuery | ||
Description |
Gets an obstacle enabler query. | ||
Return | osid.mapping.path.rules.ObstacleEnablerQuery | the obstacle enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerSearchOrder | ||
Description |
Gets an obstacle enabler search order. | ||
Return | osid.mapping.path.rules.ObstacleEnablerSearchOrder | the obstacle enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyObstacleEnablerQuery | ||
Description |
Applies an obstacle enabler query to this map. | ||
Parameters | osid.mapping.path.rules.ObstacleEnablerQuery | obstacleEnablerQuery | the obstacle enabler query |
Errors | NULL_ARGUMENT | obstacleEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | obstacleEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectObstacleEnablerQuery | ||
Description |
Gets an obstacle enabler query inspector for this map. | ||
Return | osid.mapping.path.rules.ObstacleEnablerQueryInspector | the obstacle enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyObstacleEnablerSequencing | ||
Description |
Applies an obstacle enabler search order to this map. | ||
Parameters | osid.mapping.path.rules.ObstacleEnablerSearchOrder | obstacleEnablerSearchOrder | the obstacle enabler search order |
Errors | NULL_ARGUMENT | obstacleEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | obstacleEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerQueryFromInspector | ||
Description |
Gets an obstacle enabler query from an inspector. | ||
Parameters | osid.mapping.path.rules.ObstacleEnablerQueryInspector | obstacleEnablerQueryInspector | an obstacle enabler query inspector |
Return | osid.mapping.path.rules.ObstacleEnablerQuery | the obstacle enabler query | |
Errors | NULL_ARGUMENT | obstacleEnablerQueryInspector is null | |
UNSUPPORTED | obstacleEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |