org.osid.provisioning.rules

Interface QueueConstrainerSearchOrder

All Superinterfaces:

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

public interface QueueConstrainerSearchOrder
extends OsidConstrainerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
QueueConstrainerSearchOrderRecord	getQueueConstrainerSearchOrderRecord(Type queueConstrainerRecordType) Gets the queue constrainer search order record corresponding to the given queue constrainer record Type.
void	orderByRequiresProvisions(SearchOrderStyle style) Orders the results by the requires provisions flag.
void	orderBySizeLimit(SearchOrderStyle style) Orders the results by queue size limit.

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

orderBySizeLimit

void orderBySizeLimit(SearchOrderStyle style)

Orders the results by queue size limit.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRequiresProvisions

void orderByRequiresProvisions(SearchOrderStyle style)

Orders the results by the requires provisions flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerSearchOrderRecord

QueueConstrainerSearchOrderRecord getQueueConstrainerSearchOrderRecord(Type queueConstrainerRecordType)
                                                                       throws OperationFailedException

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

Parameters:

queueConstrainerRecordType - a queue constrainer record type

Returns:

the queue constrainer search order record

Throws:

NullArgumentException - queueConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.