public interface EngineSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
EngineQueryInspector |
getEngineQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
EngineList |
getEngines()
Gets the engine list resulting from a search.
|
EngineSearchResultsRecord |
getEngineSearchResultsRecord(Type engineSearchRecordType)
Gets the engine search results record corresponding to the given
engine search record Type.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
EngineList getEngines()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. EngineQueryInspector getEngineQueryInspector()
mandatory
- This method must be implemented. EngineSearchResultsRecord getEngineSearchResultsRecord(Type engineSearchRecordType) throws OperationFailedException
engineSearchRecordType
- an engine search record typeNullArgumentException
- EngineSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(engineSearchRecordType)
is false
mandatory
- This method must be implemented.