Interface BrokerConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BrokerConstrainerSearch
extends OsidSearch

The search interface for governing broker constrainer searches.

Method Summary

Modifier and Type	Method	Description
BrokerConstrainerSearchRecord	getBrokerConstrainerSearchRecord(Type brokerConstrainerSearchRecordType)	Gets the broker constrainer search record corresponding to the given broker constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderBrokerConstrainerResults(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBrokerConstrainers(IdList brokerConstrainerIds)	Execute this search among the given list of broker constrainers.

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

searchAmongBrokerConstrainers

void searchAmongBrokerConstrainers(IdList brokerConstrainerIds)

Execute this search among the given list of broker constrainers.

Parameters:

brokerConstrainerIds - list of broker constrainer

Throws:

NullArgumentException - brokerConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderBrokerConstrainerResults

void orderBrokerConstrainerResults(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

brokerConstrainerSearchOrder - broker constrainer search order

Throws:

NullArgumentException - brokerConstrainerSearchOrder is null

UnsupportedException - brokerConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerSearchRecord

BrokerConstrainerSearchRecord getBrokerConstrainerSearchRecord(Type brokerConstrainerSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

brokerConstrainerSearchRecordType - a broker constrainer search record type

Returns:

the broker constrainer search record

Throws:

NullArgumentException - brokerConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.