org.osid.control

Interface TriggerSearchOrder

All Superinterfaces:

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

public interface TriggerSearchOrder
extends OsidRuleSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ControllerSearchOrder	getControllerSearchOrder() Gets the controller search order.
StateSearchOrder	getDiscreetStateSearchOrder() Gets the discreet state search order.
TriggerSearchOrderRecord	getTriggerSearchOrderRecord(Type triggerRecordType) Gets the trigger search order record corresponding to the given trigger Type.
void	orderByChangedDiscreetState(SearchOrderStyle style) Orders the results by state change event listeners.
void	orderByChangedVariableAmount(SearchOrderStyle style) Orders the results by changed variable amount event listeners.
void	orderByController(SearchOrderStyle style) Orders the results by controller.
void	orderByDeceedsVariableAmount(SearchOrderStyle style) Orders the results by deceeds variable amount event listeners.
void	orderByDiscreetState(SearchOrderStyle style) Orders the results by state listeners.
void	orderByExceedsVariableAmount(SearchOrderStyle style) Orders the results by exceeds variable amount event listeners.
void	orderByTurnedOff(SearchOrderStyle style) Orders the results by OFF event listeners.
void	orderByTurnedOn(SearchOrderStyle style) Orders the results by ON event listeners.
boolean	supportsControllerSearchOrder() Tests if a controller search order is available.
boolean	supportsDiscreetStateSearchOrder() Tests if a state search order is available.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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

orderByController

void orderByController(SearchOrderStyle style)

Orders the results by controller.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsControllerSearchOrder

boolean supportsControllerSearchOrder()

Tests if a controller search order is available.

Returns:

true if a controller search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getControllerSearchOrder

ControllerSearchOrder getControllerSearchOrder()

Gets the controller search order.

Returns:

the controller search order

Throws:

IllegalStateException - supportsControllerSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByTurnedOn

void orderByTurnedOn(SearchOrderStyle style)

Orders the results by ON event listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTurnedOff

void orderByTurnedOff(SearchOrderStyle style)

Orders the results by OFF event listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByChangedVariableAmount

void orderByChangedVariableAmount(SearchOrderStyle style)

Orders the results by changed variable amount event listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByExceedsVariableAmount

void orderByExceedsVariableAmount(SearchOrderStyle style)

Orders the results by exceeds variable amount event listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDeceedsVariableAmount

void orderByDeceedsVariableAmount(SearchOrderStyle style)

Orders the results by deceeds variable amount event listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByChangedDiscreetState

void orderByChangedDiscreetState(SearchOrderStyle style)

Orders the results by state change event listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDiscreetState

void orderByDiscreetState(SearchOrderStyle style)

Orders the results by state listeners.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsDiscreetStateSearchOrder

boolean supportsDiscreetStateSearchOrder()

Tests if a state search order is available.

Returns:

true if a state search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDiscreetStateSearchOrder

StateSearchOrder getDiscreetStateSearchOrder()

Gets the discreet state search order.

Returns:

the state search order

Throws:

IllegalStateException - supportsDiscreetStateSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getTriggerSearchOrderRecord

TriggerSearchOrderRecord getTriggerSearchOrderRecord(Type triggerRecordType)
                                                     throws OperationFailedException

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

Parameters:

triggerRecordType - a trigger record type

Returns:

the trigger search order record

Throws:

NullArgumentException - triggerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerRecordType) is false

Compliance:

mandatory - This method must be implemented.