public interface ResultSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ResultQueryInspector |
getResultQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ResultList |
getResults()
Gets the result list resulting from a search.
|
ResultSearchResultsRecord |
getResultSearchResultsRecord(Type resultSearchRecordType)
Gets the record corresponding to the given result search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ResultList getResults()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. ResultQueryInspector getResultQueryInspector()
mandatory
- This method must be implemented. ResultSearchResultsRecord getResultSearchResultsRecord(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.