public interface PoolSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
PoolQueryInspector |
getPoolQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
PoolList |
getPools()
Gets the pool list resulting from a search.
|
PoolSearchResultsRecord |
getPoolSearchResultsRecord(Type poolSearchRecordType)
Gets the pool search results record corresponding to the given pool
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PoolList getPools()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. PoolQueryInspector getPoolQueryInspector()
mandatory
- This method must be implemented. PoolSearchResultsRecord getPoolSearchResultsRecord(Type poolSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.poolSearchRecordType
- a pool search record typeNullArgumentException
- poolSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolSearchRecordType)
is false
mandatory
- This method must be implemented.