public interface ChainSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ChainQueryInspector |
getChainQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ChainList |
getChains()
Gets the chain list resulting from a search.
|
ChainSearchResultsRecord |
getChainSearchResultsRecord(Type chainSearchRecordType)
Gets the chain search results record corresponding to the given chain
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ChainList getChains()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ChainQueryInspector getChainQueryInspector()
mandatory
- This method must be implemented. ChainSearchResultsRecord getChainSearchResultsRecord(Type chainSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.chainSearchRecordType
- a chain search record typeNullArgumentException
- chainSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(chainSearchRecordType)
is false
mandatory
- This method must be implemented.