Interface BrokerConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BrokerConstrainerEnablerSearch
extends OsidSearch

The search interface for governing broker constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
BrokerConstrainerEnablerSearchRecord	getBrokerConstrainerEnablerSearchRecord(Type brokerConstrainerEnablerSearchRecordType)	Gets the broker constrainer enabler search record corresponding to the given broker constrainer enabler search record Type.
void	orderBrokerConstrainerEnablerResults(BrokerConstrainerEnablerSearchOrder brokerConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBrokerConstrainerEnablers(IdList brokerConstrainerEnablerIds)	Execute this search among the given list of broker constrainer enablers.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBrokerConstrainerEnablers

void searchAmongBrokerConstrainerEnablers(IdList brokerConstrainerEnablerIds)

Execute this search among the given list of broker constrainer enablers.

Parameters:

brokerConstrainerEnablerIds - list of broker constrainer enablers

Throws:

NullArgumentException - brokerConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderBrokerConstrainerEnablerResults

void orderBrokerConstrainerEnablerResults(BrokerConstrainerEnablerSearchOrder brokerConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

brokerConstrainerEnablerSearchOrder - broker constrainer enabler search order

Throws:

NullArgumentException - brokerConstrainerEnablerSearchOrder is null

UnsupportedException - brokerConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablerSearchRecord

BrokerConstrainerEnablerSearchRecord getBrokerConstrainerEnablerSearchRecord(Type brokerConstrainerEnablerSearchRecordType)
                                                                      throws OperationFailedException

Gets the broker constrainer enabler search record corresponding to the given broker constrainer enabler search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

brokerConstrainerEnablerSearchRecordType - a broker constrainer enabler search record type

Returns:

the broker constrainer enabler search record

Throws:

NullArgumentException - brokerConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.