Interface | osid.mapping.path.rules.ObstacleEnablerSearchSession | ||
---|---|---|---|
Implements | osid.mapping.path.rules.ObstacleEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getObstacleEnablerSearch | ||
Description |
Gets an obstacle enabler search. | ||
Return | osid.mapping.path.rules.ObstacleEnablerSearch | the obstacle enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerSearchOrder | ||
Description |
Gets an obstacle enabler search order. The | ||
Return | osid.mapping.path.rules.ObstacleEnablerSearchOrder | the obstacle enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.mapping.path.rules.ObstacleEnablerQuery | obstacleEnablerQuery | the obstacle enabler query |
osid.mapping.path.rules.ObstacleEnablerSearch | obstacleEnablerSearch | the obstacle enabler search | |
Return | osid.mapping.path.rules.ObstacleEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | obstacleEnablerQuery or obstacleEnablerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | obstacleEnablerQuery or obstacleEnablerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleEnablerQueryFromInspector | ||
Description |
Gets an obstacle enabler query from an inspector. The
inspector is available from an | ||
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. |