OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerQuery
Implementsosid.OsidRuleQuery
osid.OsidSubjugateableQuery
Description

This is the query for searching triggers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchControllerId
Description

Sets the controller Id for this query.

Parametersosid.id.IdcontrollerIda controller Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT controllerId is null
CompliancemandatoryThis method must be implemented.
MethodclearControllerIdTerms
Description

Clears the controller Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsControllerQuery
Description

Tests if a ControllerQuery is available.

Returnboolean true if a controller query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetControllerQuery
Description

Gets the query for a controller. Multiple retrievals produce a nested OR term.

Returnosid.control.ControllerQuerythe controller query
ErrorsUNIMPLEMENTED supportsControllerQuery() is false
ComplianceoptionalThis method must be implemented if supportsControllerQuery() is true.
MethodclearControllerTerms
Description

Clears the controller query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTurnedOn
Description

Matches triggers listening for ON events.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearTurnedOnTerms
Description

Clears the ON event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTurnedOff
Description

Matches triggers listening for OFF events.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearTurnedOffTerms
Description

Clears the OFF event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchChangedVariableAmount
Description

Matches triggers listening for changed amount events.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearChangedVariableAmountTerms
Description

Clears the changed amount event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchExceedsVariableAmount
Description

Matches triggers listening for exceeds amount events between the given values inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodmatchAnyExceedsVariableAmount
Description

Matches triggers with any exceeds variable amount.

Parametersbooleanmatch true to match triggers with any exceeds amount, false to match triggers with no exceeds amount
CompliancemandatoryThis method must be implemented.
MethodclearExceedsVariableAmountTerms
Description

Clears the exceeds amount event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDeceedsVariableAmount
Description

Matches triggers listening for deceeds amount events between the given values inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDeceedsVariableAmount
Description

Matches triggers with any deceeds variable amount.

Parametersbooleanmatch true to match triggers with any deceeds amount, false to match triggers with no deceeds amount
CompliancemandatoryThis method must be implemented.
MethodclearDeceedsVariableAmountTerms
Description

Clears the deceeds amount event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchChangedDiscreetState
Description

Matches triggers listening for changed state events.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearChangedDiscreetStateTerms
Description

Clears the changed state event query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDiscreetStateId
Description

Sets the state Id for this query.

Parametersosid.id.IdstateIda state Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetStateIdTerms
Description

Clears the discreet state Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDiscreetStateQuery
Description

Tests if a StateQuery is available.

Returnboolean true if a discreet state query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDiscreetStateQuery
Description

Gets the query for a discreet state. Multiple retrievals produce a nested OR term.

Returnosid.process.StateQuerythe discreet state query
ErrorsUNIMPLEMENTED supportsDiscreetStateQuery() is false
ComplianceoptionalThis method must be implemented if supportsDiscreetStateQuery() is true.
MethodmatchAnyDiscreetState
Description

Matches triggers with any discreet state.

Parametersbooleanmatch true to match triggers with any discreet state, false to match triggers with no discreet states
CompliancemandatoryThis method must be implemented.
MethodclearDiscreetStateTerms
Description

Clears the discreet state query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActionGroupId
Description

Sets the action group Id for this query.

Parametersosid.id.IdactionGroupIdan action group Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT actionGroupId is null
CompliancemandatoryThis method must be implemented.
MethodclearActionGroupIdTerms
Description

Clears the action group Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActionGroupQuery
Description

Tests if an ActionGroupQuery is available.

Returnboolean true if a action group query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupQuery
Description

Gets the query for an action group. Multiple retrievals produce a nested OR term.

Returnosid.control.ActionGroupQuerythe action group query
ErrorsUNIMPLEMENTED supportsActionGroupQuery() is false
ComplianceoptionalThis method must be implemented if supportsActionGroupQuery() is true.
MethodmatchAnyActionGroup
Description

Matches triggers with any action group.

Parametersbooleanmatch true to match triggers with any action group,, false to match triggers with no action groups
CompliancemandatoryThis method must be implemented.
MethodclearActionGroupTerms
Description

Clears the action group query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSceneId
Description

Sets the scene Id for this query.

Parametersosid.id.IdsceneIda scene Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT sceneId is null
CompliancemandatoryThis method must be implemented.
MethodclearSceneIdTerms
Description

Clears the scene Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSceneQuery
Description

Tests if a SceneQuery is available.

Returnboolean true if a scene query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSceneQuery
Description

Gets the query for a scene. Multiple retrievals produce a nested OR term.

Returnosid.control.SceneQuerythe scene query
ErrorsUNIMPLEMENTED supportsSceneQuery() is false
ComplianceoptionalThis method must be implemented if supportsSceneQuery() is true.
MethodmatchAnyScene
Description

Matches triggers with any scene.

Parametersbooleanmatch true to match triggers with any scene, false to match triggers with no scenes
CompliancemandatoryThis method must be implemented.
MethodclearSceneTerms
Description

Clears the scene query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSettingId
Description

Sets the setting Id for this query.

Parametersosid.id.IdsettingIda setting Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT settingId is null
CompliancemandatoryThis method must be implemented.
MethodclearSettingIdTerms
Description

Clears the setting Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSettingQuery
Description

Tests if a SettingQuery is available.

Returnboolean true if a setting query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSettingQuery
Description

Gets the query for a setting. Multiple retrievals produce a nested OR term.

Returnosid.control.SettingQuerythe setting query
ErrorsUNIMPLEMENTED supportsSettingQuery() is false
ComplianceoptionalThis method must be implemented if supportsSettingQuery() is true.
MethodmatchAnySetting
Description

Matches triggers with any setting.

Parametersbooleanmatch true to match triggers with any setting, false to match triggers with no settings
CompliancemandatoryThis method must be implemented.
MethodclearSettingTerms
Description

Clears the setting query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSystemId
Description

Sets the system Id for this query to match triggers assigned to systems.

Parametersosid.id.IdtriggerIdthe trigger Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT triggerId is null
CompliancemandatoryThis method must be implemented.
MethodclearSystemIdTerms
Description

Clears the system Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSystemQuery
Description

Tests if a SystemQuery is available.

Returnboolean true if a system query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSystemQuery
Description

Gets the query for a system. Multiple retrievals produce a nested OR term.

Returnosid.control.SystemQuerythe system query
ErrorsUNIMPLEMENTED supportsSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsSystemQuery() is true.
MethodclearSystemTerms
Description

Clears the system query terms.

CompliancemandatoryThis method must be implemented.
MethodgetTriggerQueryRecord
Description

Gets the trigger query record corresponding to the given Trigger record Type. Multiple record retrievals produce a nested OR term.

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