org.osid.control

Interface ControllerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, Suppliable

public interface ControllerSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ControllerSearchOrderRecord	getControllerSearchOrderRecord(Type controllerRecordType) Gets the controller search order record corresponding to the given controller record Type.
ModelSearchOrder	getModelSearchOrder() Gets the model search order.
void	orderByAddress(SearchOrderStyle style) Orders the results by address.
void	orderByDiscreetStates(SearchOrderStyle style) Orders the results by the variable by discreet state capabilities.
void	orderByModel(SearchOrderStyle style) Orders the results by model.
void	orderByToggleable(SearchOrderStyle style) Orders the results by the toggles.
void	orderByVariable(SearchOrderStyle style) Orders the results by the variable capabilities.
void	orderByVariableMaximum(SearchOrderStyle style) Orders the results by variable maximum.
void	orderByVariableMinimum(SearchOrderStyle style) Orders the results by variable minimum.
void	orderByVariablePercentage(SearchOrderStyle style) Orders the results by the variable by percentage capabilities.
void	orderByVersion(SearchOrderStyle style) Orders the results by version.
boolean	supportsModelSearchOrder() Tests if a model 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

Method Detail

orderByAddress

void orderByAddress(SearchOrderStyle style)

Orders the results by address.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByModel

void orderByModel(SearchOrderStyle style)

Orders the results by model.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsModelSearchOrder

boolean supportsModelSearchOrder()

Tests if a model search order is available.

Returns:

true if a model search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getModelSearchOrder

ModelSearchOrder getModelSearchOrder()

Gets the model search order.

Returns:

the model search order

Throws:

IllegalStateException - supportsModelSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByVersion

void orderByVersion(SearchOrderStyle style)

Orders the results by version.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByToggleable

void orderByToggleable(SearchOrderStyle style)

Orders the results by the toggles.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByVariable

void orderByVariable(SearchOrderStyle style)

Orders the results by the variable capabilities.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByVariablePercentage

void orderByVariablePercentage(SearchOrderStyle style)

Orders the results by the variable by percentage capabilities.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByVariableMinimum

void orderByVariableMinimum(SearchOrderStyle style)

Orders the results by variable minimum.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByVariableMaximum

void orderByVariableMaximum(SearchOrderStyle style)

Orders the results by variable maximum.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDiscreetStates

void orderByDiscreetStates(SearchOrderStyle style)

Orders the results by the variable by discreet state capabilities.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getControllerSearchOrderRecord

ControllerSearchOrderRecord getControllerSearchOrderRecord(Type controllerRecordType)
                                                           throws OperationFailedException

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

Parameters:

controllerRecordType - a controller record type

Returns:

the controller search order record

Throws:

NullArgumentException - controllerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(controllerRecordType) is false

Compliance:

mandatory - This method must be implemented.