Interface | osid.mapping.path.ObstacleSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getObstacles | ||
Description |
Gets the obstacle list resulting from a search. | ||
Return | osid.mapping.path.ObstacleList | the obstacle list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.mapping.path.ObstacleQueryInspector | the obstacle query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleSearchResultsRecord | ||
Description |
Gets the record corresponding to the given obstacle
search record | ||
Parameters | osid.type.Type | obstacleSearchRecordType | an obstacle search record type |
Return | osid.mapping.path.records.ObstacleSearchResultsRecord | the obstacle search results record | |
Errors | NULL_ARGUMENT | obstacleSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(obstacleSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |