Interface BrokerProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BrokerProcessorSearch
extends OsidSearch

The search interface for governing broker processor searches.

Method Summary

Modifier and Type	Method	Description
BrokerProcessorSearchRecord	getBrokerProcessorSearchRecord(Type brokerProcessorSearchRecordType)	Gets the broker processor search record corresponding to the given broker processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderBrokerProcessorResults(BrokerProcessorSearchOrder brokerProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongBrokerProcessors(IdList brokerProcessorIds)	Execute this search among the given list of broker processors.

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

searchAmongBrokerProcessors

void searchAmongBrokerProcessors(IdList brokerProcessorIds)

Execute this search among the given list of broker processors.

Parameters:

brokerProcessorIds - list of broker processors

Throws:

NullArgumentException - brokerProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderBrokerProcessorResults

void orderBrokerProcessorResults(BrokerProcessorSearchOrder brokerProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

brokerProcessorSearchOrder - broker processor search order

Throws:

NullArgumentException - brokerProcessorSearchOrder is null

UnsupportedException - brokerProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorSearchRecord

BrokerProcessorSearchRecord getBrokerProcessorSearchRecord(Type brokerProcessorSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

brokerProcessorSearchRecordType - a broker processor search record type

Returns:

the broker processor search record

Throws:

NullArgumentException - brokerProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.