Interface | osid.mapping.path.ObstacleSearchSession | ||
---|---|---|---|
Implements | osid.mapping.path.ObstacleQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Obstacles may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getObstacleSearch | ||
Description |
Gets an obstacle search. | ||
Return | osid.mapping.path.ObstacleSearch | the obstacle search | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleSearchOrder | ||
Description |
Gets an obstacle search order. The | ||
Return | osid.mapping.path.ObstacleSearchOrder | the obstacle search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstaclesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.mapping.path.ObstacleQuery | obstacleQuery | the obstacle query |
osid.mapping.path.ObstacleSearch | obstacleSearch | the obstacle search | |
Return | osid.mapping.path.ObstacleSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | obstacleQuery or obstacleSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | obstacleQuery or obstacleSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleQueryFromInspector | ||
Description |
Gets an obstacle query from an inspector. The inspector
is available from an | ||
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. |