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

Modifier and Type	Method	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 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 OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

Methods inherited from interface OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Modifier and Type	Method	Description
RuleSearchOrder	getRuleSearchOrder()	Gets the search order for a rule.
void	orderByRule(SearchOrderStyle style)	Specifies a preference for ordering the results by the associated rule.
boolean	supportsRuleSearchOrder()	Tests if a RuleSearchOrder is available.

Method Details

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.