| Interface | osid.inquiry.ResponseSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing response searches. | ||
| Method | searchAmongResponses | ||
| Description |
Execute this search among the given list of responses. | ||
| Parameters | osid.id.IdList | responseIds | list of responses |
| Errors | NULL_ARGUMENT | responseIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderResponseResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.inquiry.ResponseSearchOrder | responseSearchOrder | response search order |
| Errors | NULL_ARGUMENT | responseSearchOrder is null | |
| UNSUPPORTED | responseSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseSearchRecord | ||
| Description |
Gets the response search record corresponding to the
given response search record | ||
| Parameters | osid.type.Type | responseSearchRecordType | a response search record type |
| Return | osid.inquiry.records.ResponseSearchRecord | the response search interface | |
| Errors | NULL_ARGUMENT | responseSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(responseSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |