Interface | osid.mapping.path.ObstacleSmartMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. 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 | getObstacleQuery | ||
Description |
Gets an obstacle query. | ||
Return | osid.mapping.path.ObstacleQuery | the obstacle query | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleSearchOrder | ||
Description |
Gets an obstacle search order. | ||
Return | osid.mapping.path.ObstacleSearchOrder | the obstacle search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyObstacleQuery | ||
Description |
Applies an obstacle query to this map. | ||
Parameters | osid.mapping.path.ObstacleQuery | obstacleQuery | the obstacle query |
Errors | NULL_ARGUMENT | obstacleQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | obstacleQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspecObstacleQuery | ||
Description |
Gets an obstacle query inspector for this map. | ||
Return | osid.mapping.path.ObstacleQueryInspector | the obstacle query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyObstacleSequencing | ||
Description |
Applies an obstacle search order to this map. | ||
Parameters | osid.mapping.path.ObstacleSearchOrder | obstacleSearchOrder | the obstacle search order |
Errors | NULL_ARGUMENT | obstacleSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | obstacleSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleQueryFromInspector | ||
Description |
Gets an obstacle query from an inspector. | ||
Parameters | osid.mapping.path.ObstacleQueryInspector | obstacleQueryInspector | an obstacle query inspector |
Return | osid.mapping.path.ObstacleQuery | the obstacle query | |
Errors | NULL_ARGUMENT | obstacleQueryInspector is null | |
UNSUPPORTED | obstacleQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |