public interface ResultSearch extends OsidSearch
The search interface for governing result searches.
Modifier and Type | Method and Description |
---|---|
ResultSearchRecord |
getResultSearchRecord(Type resultSearchRecordType)
Gets the record corresponding to the given result search record
Type. |
void |
orderResultResults(ResultSearchOrder resultSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongResults(IdList resultIds)
Execute this search among the given list of results.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongResults(IdList resultIds)
resultIds
- list of resultsNullArgumentException
- resultIds
is
null
mandatory
- This method must be implemented. void orderResultResults(ResultSearchOrder resultSearchOrder)
resultSearchOrder
- result search orderNullArgumentException
- resultSearchOrder
is null
UnsupportedException
- resultSearchOrder
is not of this servicemandatory
- This method must be implemented. ResultSearchRecord getResultSearchRecord(Type resultSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.resultSearchRecordType
- an result search record typeNullArgumentException
- resultSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resultSearchRecordType)
is false
mandatory
- This method must be implemented.