OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerSearchOrder
Implementsosid.OsidRuleSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByController
Description

Orders the results by controller.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsControllerSearchOrder
Description

Tests if a controller search order is available.

Returnboolean true if a controller search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchOrder
Description

Gets the controller search order.

Returnosid.control.ControllerSearchOrderthe controller search order
ErrorsILLEGAL_STATE supportsControllerSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByTurnedOn
Description

Orders the results by ON event listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByTurnedOff
Description

Orders the results by OFF event listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByChangedVariableAmount
Description

Orders the results by changed variable amount event listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByExceedsVariableAmount
Description

Orders the results by exceeds variable amount event listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDeceedsVariableAmount
Description

Orders the results by deceeds variable amount event listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByChangedDiscreetState
Description

Orders the results by state change event listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDiscreetState
Description

Orders the results by state listeners.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsDiscreetStateSearchOrder
Description

Tests if a state search order is available.

Returnboolean true if a state search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetStateSearchOrder
Description

Gets the discreet state search order.

Returnosid.process.StateSearchOrderthe state search order
ErrorsILLEGAL_STATE supportsDiscreetStateSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetTriggerSearchOrderRecord
Description

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

Parametersosid.type.TypetriggerRecordTypea trigger record type
Returnosid.control.records.TriggerSearchOrderRecordthe trigger search order record
ErrorsNULL_ARGUMENT triggerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(triggerRecordType) is false
CompliancemandatoryThis method must be implemented.