| Interface | osid.control.InputSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getInputs | ||
| Description |
Gets the input list resulting from a search. | ||
| Return | osid.control.InputList | the input list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInputQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.control.InputQueryInspector | the input query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInputSearchResultsRecord | ||
| Description |
Gets the input search results record corresponding to
the given input search record | ||
| Parameters | osid.type.Type | inputSearchRecordType | an input search record type |
| Return | osid.control.records.InputSearchResultsRecord | the input search results record | |
| Errors | NULL_ARGUMENT | inputSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inputSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |