public interface PoolSearchOrder 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.
|
PoolSearchOrderRecord |
getPoolSearchOrderRecord(Type poolRecordType)
Gets the pool search order record corresponding to the given pool
record
Type. |
void |
orderByBroker(SearchOrderStyle style)
Orders the results by broker.
|
void |
orderBySize(SearchOrderStyle style)
Orders the results by pool 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. PoolSearchOrderRecord getPoolSearchOrderRecord(Type poolRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.poolRecordType
- a pool record typeNullArgumentException
- poolRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolRecordType)
is false
mandatory
- This method must be implemented.