public interface BrokerConstrainerSearch extends OsidSearch
The search interface for governing broker constrainer searches.
Modifier and Type | Method and Description |
---|---|
BrokerConstrainerSearchRecord |
getBrokerConstrainerSearchRecord(Type brokerConstrainerSearchRecordType)
Gets the broker constrainer search record corresponding to the given
broker constrainer search record
Type. |
void |
orderBrokerConstrainerResults(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBrokerConstrainers(IdList distributorIds)
Execute this search among the given list of broker constrainers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBrokerConstrainers(IdList distributorIds)
distributorIds
- list of broker constrainersNullArgumentException
- distributorIds
is null
mandatory
- This method must be implemented. void orderBrokerConstrainerResults(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder)
brokerConstrainerSearchOrder
- broker constrainer search orderNullArgumentException
-
brokerConstrainerSearchOrder
is null
UnsupportedException
-
brokerConstrainerSearchOrder
is not of this servicemandatory
- This method must be implemented. BrokerConstrainerSearchRecord getBrokerConstrainerSearchRecord(Type brokerConstrainerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.brokerConstrainerSearchRecordType
- a broker constrainer search
record typeNullArgumentException
-
brokerConstrainerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerConstrainerSearchRecordType)
is
false
mandatory
- This method must be implemented.