org.osid.provisioning

Interface BrokerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface BrokerSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerSearchOrderRecord	getBrokerSearchOrderRecord(Type brokerRecordType) Gets the broker search order record corresponding to the given broker Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getBrokerSearchOrderRecord

BrokerSearchOrderRecord getBrokerSearchOrderRecord(Type brokerRecordType)
                                                   throws OperationFailedException

Gets the broker search order record corresponding to the given broker Type. Multiple retrievals return the same underlying object.

Parameters:

brokerRecordType - a broker record type

Returns:

the broker search order record

Throws:

NullArgumentException - brokerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerRecordType) is false

Compliance:

mandatory - This method must be implemented.