Interface | osid.mapping.path.PathSmartMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A 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 | getPathQuery | ||
Description |
Gets a path query. | ||
Return | osid.mapping.path.PathQuery | the path query | |
Compliance | mandatory | This method must be implemented. | |
Method | getPathSearchOrder | ||
Description |
Gets a path search order. | ||
Return | osid.mapping.path.PathSearchOrder | the path search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyPathQuery | ||
Description |
Applies a path query to this map. | ||
Parameters | osid.mapping.path.PathQuery | pathQuery | the path query |
Errors | NULL_ARGUMENT | pathQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | pathQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectPathQuery | ||
Description |
Gets a path query inspector for this map. | ||
Return | osid.mapping.path.PathQueryInspector | the path query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyPathSequencing | ||
Description |
Applies a path search order to this map. | ||
Parameters | osid.mapping.path.PathSearchOrder | pathSearchOrder | the path search order |
Errors | NULL_ARGUMENT | pathSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | pathSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathQueryFromInspector | ||
Description |
Gets a path query from an inspector. | ||
Parameters | osid.mapping.path.PathQueryInspector | pathQueryInspector | a path query inspector |
Return | osid.mapping.path.PathQuery | the path query | |
Errors | NULL_ARGUMENT | pathQueryInspector is null | |
UNSUPPORTED | pathQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |