public interface ResponseSearch extends OsidSearch
The search interface for governing response searches.
Modifier and Type | Method and Description |
---|---|
ResponseSearchRecord |
getResponseSearchRecord(Type responseSearchRecordType)
Gets the response search record corresponding to the given response
search record
Type. |
void |
orderResponseResults(ResponseSearchOrder responseSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongResponses(IdList responseIds)
Execute this search among the given list of responses.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongResponses(IdList responseIds)
responseIds
- list of responsesNullArgumentException
- responseIds
is
null
mandatory
- This method must be implemented. void orderResponseResults(ResponseSearchOrder responseSearchOrder)
responseSearchOrder
- response search orderNullArgumentException
- responseSearchOrder
is null
UnsupportedException
- responseSearchOrder
is not of this servicemandatory
- This method must be implemented. ResponseSearchRecord getResponseSearchRecord(Type responseSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.responseSearchRecordType
- a response search record typeNullArgumentException
- responseSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(responseSearchRecordType)
is
false
mandatory
- This method must be implemented.