public interface BrokerSearch extends OsidSearch
The search interface for governing broker searches.
Modifier and Type | Method and Description |
---|---|
BrokerSearchRecord |
getBrokerSearchRecord(Type brokerSearchRecordType)
Gets the broker search record corresponding to the given broker search
record
Type. |
void |
orderBrokerResults(BrokerSearchOrder brokerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBrokers(IdList brokerIds)
Execute this search among the given list of brokers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBrokers(IdList brokerIds)
brokerIds
- list of brokersNullArgumentException
- brokerIds
is
null
mandatory
- This method must be implemented. void orderBrokerResults(BrokerSearchOrder brokerSearchOrder)
brokerSearchOrder
- broker search orderNullArgumentException
- brokerSearchOrder
is null
UnsupportedException
- brokerSearchOrder
is not of this servicemandatory
- This method must be implemented. BrokerSearchRecord getBrokerSearchRecord(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.