public interface QueueSearchOrder extends OsidGovernatorSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder
void orderByBroker(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBrokerSearchOrder()
true
if a broker search order is available,
false
otherwisemandatory
- This method must be implemented. BrokerSearchOrder getBrokerSearchOrder()
IllegalStateException
-
supportsBrokerSearchOrder()
is false
mandatory
- This method must be implemented. void orderBySize(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByEWA(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCanSpecifyProvisionable(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. QueueSearchOrderRecord getQueueSearchOrderRecord(Type queueRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.queueRecordType
- a queue record typeNullArgumentException
- queueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueRecordType)
is false
mandatory
- This method must be implemented.