Interface BrokerProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BrokerProcessorEnablerSearch
extends OsidSearch

The search interface for governing broker processor enabler searches.

Method Summary

Modifier and Type	Method	Description
BrokerProcessorEnablerSearchRecord	getBrokerProcessorEnablerSearchRecord(Type brokerProcessorEnablerSearchRecordType)	Gets the broker processor enabler search record corresponding to the given broker processor enabler search record Type.
void	orderBrokerProcessorEnablerResults(BrokerProcessorEnablerSearchOrder brokerProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBrokerProcessorEnablers(IdList brokerProcessorEnablerIds)	Execute this search among the given list of broker processor 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

searchAmongBrokerProcessorEnablers

void searchAmongBrokerProcessorEnablers(IdList brokerProcessorEnablerIds)

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

Parameters:

brokerProcessorEnablerIds - list of broker processor enablers

Throws:

NullArgumentException - brokerProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderBrokerProcessorEnablerResults

void orderBrokerProcessorEnablerResults(BrokerProcessorEnablerSearchOrder brokerProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

brokerProcessorEnablerSearchOrder - broker processor enabler search order

Throws:

NullArgumentException - brokerProcessorEnablerSearchOrder is null

UnsupportedException - brokerProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorEnablerSearchRecord

BrokerProcessorEnablerSearchRecord getBrokerProcessorEnablerSearchRecord(Type brokerProcessorEnablerSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

brokerProcessorEnablerSearchRecordType - a broker processor enabler search record type

Returns:

the broker processor enabler search record

Throws:

NullArgumentException - brokerProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.