Interface | osid.mapping.path.IntersectionSmartMapSession | ||
---|---|---|---|
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 | getIntersectionQuery | ||
Description |
Gets an intersection query. | ||
Return | osid.mapping.path.IntersectionQuery | the intersection query | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionSearchOrder | ||
Description |
Gets an intersection search order. | ||
Return | osid.mapping.path.IntersectionSearchOrder | the intersection search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyIntersectionQuery | ||
Description |
Applies an intersection query to this map. | ||
Parameters | osid.mapping.path.IntersectionQuery | intersectionQuery | the intersection query |
Errors | NULL_ARGUMENT | intersectionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | intersectionQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectIntersectionQuery | ||
Description |
Gets an intersection query inspector for this map. | ||
Return | osid.mapping.path.IntersectionQueryInspector | the intersection query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyIntersectionSequencing | ||
Description |
Applies an intersection search order to this map. | ||
Parameters | osid.mapping.path.IntersectionSearchOrder | intersectionSearchOrder | the intersection search order |
Errors | NULL_ARGUMENT | intersectionSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | intersectionsearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionQueryFromInspector | ||
Description |
Gets an intersection query from an inspector. | ||
Parameters | osid.mapping.path.IntersectionQueryInspector | intersectionQueryInspector | an intersection query inspector |
Return | osid.mapping.path.IntersectionQuery | the intersection query | |
Errors | NULL_ARGUMENT | intersectionQueryInspector is null | |
UNSUPPORTED | intersectionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |