Interface BrokerConstrainerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidConstrainerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface BrokerConstrainerSearchOrder
extends OsidConstrainerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
BrokerConstrainerSearchOrderRecord	getBrokerConstrainerSearchOrderRecord(Type brokerConstrainerRecordType)	Gets the broker constrainer search order record corresponding to the given broker constrainer record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Methods inherited from interface OsidObjectSearchOrder

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

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Methods inherited from interface OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Method Details

getBrokerConstrainerSearchOrderRecord

BrokerConstrainerSearchOrderRecord getBrokerConstrainerSearchOrderRecord(Type brokerConstrainerRecordType)
                                                                  throws OperationFailedException

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

Parameters:

brokerConstrainerRecordType - a broker constrainer record type

Returns:

the broker constrainer search order record

Throws:

NullArgumentException - brokerConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.