| Interface | osid.inquiry.ResponseSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 This interface provides a means to capture results of a search.  | ||
| Method | getResponses | ||
| Description | 
                     Gets the response list resulting from a search.  | ||
| Return | osid.inquiry.ResponseList | the response list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.inquiry.ResponseQueryInspector | the response query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseSearchResultsRecord | ||
| Description | 
                     Gets the response search results record corresponding 
                    to the given response search record   | ||
| Parameters | osid.type.Type | responseSearchRecordType | a response search record type | 
| Return | osid.inquiry.records.ResponseSearchResultsRecord | the response search results record | |
| Errors | NULL_ARGUMENT |  responseSearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(responseSearchRecordType)  is  false 
  |                 ||
| Compliance | mandatory | This method must be implemented. | |