Interface BrokerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BrokerEnablerSearch
extends OsidSearch

The search interface for governing broker enabler searches.

Method Summary

Modifier and Type	Method	Description
BrokerEnablerSearchRecord	getBrokerEnablerSearchRecord(Type brokerEnablerSearchRecordType)	Gets the broker enabler search record corresponding to the given broker enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderBrokerEnablerResults(BrokerEnablerSearchOrder brokerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBrokerEnablers(IdList brokerEnablerIds)	Execute this search among the given list of broker 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

searchAmongBrokerEnablers

void searchAmongBrokerEnablers(IdList brokerEnablerIds)

Execute this search among the given list of broker enablers.

Parameters:

brokerEnablerIds - list of broker enablers

Throws:

NullArgumentException - brokerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderBrokerEnablerResults

void orderBrokerEnablerResults(BrokerEnablerSearchOrder brokerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

brokerEnablerSearchOrder - broker enabler search order

Throws:

NullArgumentException - brokerEnablerSearchOrder is null

UnsupportedException - brokerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerEnablerSearchRecord

BrokerEnablerSearchRecord getBrokerEnablerSearchRecord(Type brokerEnablerSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

brokerEnablerSearchRecordType - a broker enabler search record type

Returns:

the broker enabler search record

Throws:

NullArgumentException - brokerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.