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

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

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Modifier and Type	Method	Description
ResourceSearchOrder	getProviderSearchOrder()	Gets the search order interface for a provider.
void	orderByProvider(SearchOrderStyle style)	Specifies a preference for ordering the results by provider.
boolean	supportsProviderSearchOrder()	Tests if a ProviderSearchOrder interface is available.

Method Details

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.