Interface BrokerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BrokerSearch
extends OsidSearch

The search interface for governing broker searches.

Method Summary

Modifier and Type	Method	Description
BrokerSearchRecord	getBrokerSearchRecord(Type brokerSearchRecordType)	Gets the broker search record corresponding to the given broker search record Type .
void	orderBrokerResults(BrokerSearchOrder brokerSearchOrder)	Specify an ordering to the search results.
void	searchAmongBrokers(IdList brokerIds)	Execute this search among the given list of brokers.

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

searchAmongBrokers

void searchAmongBrokers(IdList brokerIds)

Execute this search among the given list of brokers.

Parameters:

brokerIds - list of brokers

Throws:

NullArgumentException - brokerIds is null

Compliance:

mandatory - This method must be implemented.

orderBrokerResults

void orderBrokerResults(BrokerSearchOrder brokerSearchOrder)

Specify an ordering to the search results.

Parameters:

brokerSearchOrder - broker search order

Throws:

NullArgumentException - brokerSearchOrder is null

UnsupportedException - brokerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerSearchRecord

BrokerSearchRecord getBrokerSearchRecord(Type brokerSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

brokerSearchRecordType - a broker search record type

Returns:

the broker search record

Throws:

NullArgumentException - brokerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.