org.osid.provisioning.rules

Interface BrokerProcessorSearchOrder

All Superinterfaces:

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

public interface BrokerProcessorSearchOrder
extends OsidProcessorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerProcessorSearchOrderRecord	getBrokerProcessorSearchOrderRecord(Type brokerProcessorRecordType) Gets the broker processor search order record corresponding to the given broker processor record Type.
void	orderByAllowsCompoundRequests(SearchOrderStyle style) Orders the results by the allows compound requests flag.
void	orderByAllowsProvisionExchange(SearchOrderStyle style) Orders the results by the allows provision exchange flag.
void	orderByFixedLeaseDuration(SearchOrderStyle style) Orders the results by the fixed lease duration.
void	orderByLeasing(SearchOrderStyle style) Orders the results by the leasing flag.
void	orderByMustReturnProvisions(SearchOrderStyle style) Orders the results by the must return provisions flag.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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

Method Detail

orderByLeasing

void orderByLeasing(SearchOrderStyle style)

Orders the results by the leasing flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFixedLeaseDuration

void orderByFixedLeaseDuration(SearchOrderStyle style)

Orders the results by the fixed lease duration.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMustReturnProvisions

void orderByMustReturnProvisions(SearchOrderStyle style)

Orders the results by the must return provisions flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAllowsProvisionExchange

void orderByAllowsProvisionExchange(SearchOrderStyle style)

Orders the results by the allows provision exchange flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByAllowsCompoundRequests

void orderByAllowsCompoundRequests(SearchOrderStyle style)

Orders the results by the allows compound requests flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorSearchOrderRecord

BrokerProcessorSearchOrderRecord getBrokerProcessorSearchOrderRecord(Type brokerProcessorRecordType)
                                                                     throws OperationFailedException

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

Parameters:

brokerProcessorRecordType - a broker processor record type

Returns:

the broker processor search order record

Throws:

NullArgumentException - brokerProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.