org.osid.provisioning

Interface ProvisionableSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface ProvisionableSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PoolSearchOrder	getPoolSearchOrder() Gets the pool search order.
ProvisionableSearchOrderRecord	getProvisionableSearchOrderRecord(Type provisionableRecordType) Gets the provisionable search order record corresponding to the given provisionable record Type.
ResourceSearchOrder	getResourceSearchOrder() Gets the resource search order.
void	orderByPool(SearchOrderStyle style) Orders the results by pool.
void	orderByResource(SearchOrderStyle style) Orders the results by resource.
void	orderByUse(SearchOrderStyle style) Orders the results by use.
boolean	supportsPoolSearchOrder() Tests if a pool search order is available.
boolean	supportsResourceSearchOrder() Tests if a resource search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByPool

void orderByPool(SearchOrderStyle style)

Orders the results by pool.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPoolSearchOrder

boolean supportsPoolSearchOrder()

Tests if a pool search order is available.

Returns:

true if a pool search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPoolSearchOrder

PoolSearchOrder getPoolSearchOrder()

Gets the pool search order.

Returns:

the pool search order

Throws:

IllegalStateException - supportsPoolSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByResource

void orderByResource(SearchOrderStyle style)

Orders the results by resource.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsResourceSearchOrder

boolean supportsResourceSearchOrder()

Tests if a resource search order is available.

Returns:

true if a resource search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets the resource search order.

Returns:

the resource search order

Throws:

IllegalStateException - supportsResourceSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByUse

void orderByUse(SearchOrderStyle style)

Orders the results by use.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getProvisionableSearchOrderRecord

ProvisionableSearchOrderRecord getProvisionableSearchOrderRecord(Type provisionableRecordType)
                                                                 throws OperationFailedException

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

Parameters:

provisionableRecordType - a provisionable record type

Returns:

the provisionable order record interface

Throws:

NullArgumentException - provisionableRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableRecordType) is false

Compliance:

mandatory - This method must be implemented.