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

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

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getEndReasonSearchOrder()	Gets the search order for a state.
void	orderByEndReason(SearchOrderStyle style)	Specifies a preference for ordering the results by the end reason state.
boolean	supportsEndReasonSearchOrder()	Tests if a StateSearchOrder is available.

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

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.