| Interface | osid.inquiry.InquestSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getInquests | ||
| Description |
Gets the inquest list resulting from a search. | ||
| Return | osid.inquiry.InquestList | the inquest list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.inquiry.InquestQueryInspector | the inquest query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquestSearchResultsRecord | ||
| Description |
Gets the inquest search results record corresponding to
the given inquest search record | ||
| Parameters | osid.type.Type | inquestSearchRecordType | an inquest search record type |
| Return | osid.inquiry.records.InquestSearchResultsRecord | the inquest search results record | |
| Errors | NULL_ARGUMENT | inquestSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inquestSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |