public interface BrokerSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
BrokerQueryInspector |
getBrokerQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
BrokerList |
getBrokers()
Gets the broker list resulting from a search.
|
BrokerSearchResultsRecord |
getBrokerSearchResultsRecord(Type brokerSearchRecordType)
Gets the broker search results record corresponding to the given
broker search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BrokerList getBrokers()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. BrokerQueryInspector getBrokerQueryInspector()
mandatory
- This method must be implemented. BrokerSearchResultsRecord getBrokerSearchResultsRecord(Type brokerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.brokerSearchRecordType
- a broker search record typeNullArgumentException
- brokerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerSearchRecordType)
is false
mandatory
- This method must be implemented.