org.osid.provisioning

Interface QueueSearchOrder

All Superinterfaces:

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

public interface QueueSearchOrder
extends OsidGovernatorSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerSearchOrder	getBrokerSearchOrder() Gets the broker search order.
QueueSearchOrderRecord	getQueueSearchOrderRecord(Type queueRecordType) Gets the queue search order record corresponding to the given queue record Type.
void	orderByBroker(SearchOrderStyle style) Orders the results by broker.
void	orderByCanSpecifyProvisionable(SearchOrderStyle style) Orders the results by the can request provisionables flag.
void	orderByEWA(SearchOrderStyle style) Orders the results by estimated waiting time.
void	orderBySize(SearchOrderStyle style) Orders the results by queue size.
boolean	supportsBrokerSearchOrder() Tests if a broker search order is available.

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

orderByBroker

void orderByBroker(SearchOrderStyle style)

Orders the results by broker.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsBrokerSearchOrder

boolean supportsBrokerSearchOrder()

Tests if a broker search order is available.

Returns:

true if a broker search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerSearchOrder

BrokerSearchOrder getBrokerSearchOrder()

Gets the broker search order.

Returns:

the broker search order

Throws:

IllegalStateException - supportsBrokerSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderBySize

void orderBySize(SearchOrderStyle style)

Orders the results by queue size.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEWA

void orderByEWA(SearchOrderStyle style)

Orders the results by estimated waiting time.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCanSpecifyProvisionable

void orderByCanSpecifyProvisionable(SearchOrderStyle style)

Orders the results by the can request provisionables flag.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getQueueSearchOrderRecord

QueueSearchOrderRecord getQueueSearchOrderRecord(Type queueRecordType)
                                                 throws OperationFailedException

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

Parameters:

queueRecordType - a queue record type

Returns:

the queue search order record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.