public interface TriggerSearchOrder extends OsidRuleSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
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.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByController(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsControllerSearchOrder()
true
if a controller search order is available,
false
otherwisemandatory
- This method must be implemented. ControllerSearchOrder getControllerSearchOrder()
IllegalStateException
-
supportsControllerSearchOrder()
is false
mandatory
- This method must be implemented. void orderByTurnedOn(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTurnedOff(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByChangedVariableAmount(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByExceedsVariableAmount(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDeceedsVariableAmount(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByChangedDiscreetState(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDiscreetState(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDiscreetStateSearchOrder()
true
if a state search order is available,
false
otherwisemandatory
- This method must be implemented. StateSearchOrder getDiscreetStateSearchOrder()
IllegalStateException
-
supportsDiscreetStateSearchOrder()
is false
mandatory
- This method must be implemented. TriggerSearchOrderRecord getTriggerSearchOrderRecord(Type triggerRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.triggerRecordType
- a trigger record typeNullArgumentException
- triggerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(triggerRecordType)
is false
mandatory
- This method must be implemented.