org.osid.provisioning

Interface PoolSearchOrder

All Superinterfaces:

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

public interface PoolSearchOrder
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.
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.

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 pool size.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getPoolSearchOrderRecord

PoolSearchOrderRecord getPoolSearchOrderRecord(Type poolRecordType)
                                               throws OperationFailedException

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

Parameters:

poolRecordType - a pool record type

Returns:

the pool search order record

Throws:

NullArgumentException - poolRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolRecordType) is false

Compliance:

mandatory - This method must be implemented.