Interface | osid.control.TriggerQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching triggers. Each method match
specifies an | ||
Method | matchControllerId | ||
Description |
Sets the controller | ||
Parameters | osid.id.Id | controllerId | a controller Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | controllerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearControllerIdTerms | ||
Description |
Clears the controller | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsControllerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a controller query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllerQuery | ||
Description |
Gets the query for a controller. Multiple retrievals
produce a nested | ||
Return | osid.control.ControllerQuery | the controller query | |
Errors | UNIMPLEMENTED | supportsControllerQuery() is false | |
Compliance | optional | This method must be implemented if supportsControllerQuery()
is true. | |
Method | clearControllerTerms | ||
Description |
Clears the controller query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTurnedOn | ||
Description |
Matches triggers listening for ON events. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearTurnedOnTerms | ||
Description |
Clears the ON event query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTurnedOff | ||
Description |
Matches triggers listening for OFF events. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearTurnedOffTerms | ||
Description |
Clears the OFF event query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchChangedVariableAmount | ||
Description |
Matches triggers listening for changed amount events. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearChangedVariableAmountTerms | ||
Description |
Clears the changed amount event query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchExceedsVariableAmount | ||
Description |
Matches triggers listening for exceeds amount events between the given values inclusive. | ||
Parameters | decimal | start | start of range |
decimal | end | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyExceedsVariableAmount | ||
Description |
Matches triggers with any exceeds variable amount. | ||
Parameters | boolean | match | true to match triggers with any exceeds amount, false
to match triggers with no exceeds amount |
Compliance | mandatory | This method must be implemented. | |
Method | clearExceedsVariableAmountTerms | ||
Description |
Clears the exceeds amount event query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDeceedsVariableAmount | ||
Description |
Matches triggers listening for deceeds amount events between the given values inclusive. | ||
Parameters | decimal | start | start of range |
decimal | end | end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyDeceedsVariableAmount | ||
Description |
Matches triggers with any deceeds variable amount. | ||
Parameters | boolean | match | true to match triggers with any deceeds amount, false
to match triggers with no deceeds amount |
Compliance | mandatory | This method must be implemented. | |
Method | clearDeceedsVariableAmountTerms | ||
Description |
Clears the deceeds amount event query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchChangedDiscreetState | ||
Description |
Matches triggers listening for changed state events. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearChangedDiscreetStateTerms | ||
Description |
Clears the changed state event query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDiscreetStateId | ||
Description |
Sets the state | ||
Parameters | osid.id.Id | stateId | a state Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stateId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDiscreetStateIdTerms | ||
Description |
Clears the discreet state | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDiscreetStateQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a discreet state query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDiscreetStateQuery | ||
Description |
Gets the query for a discreet state. Multiple
retrievals produce a nested | ||
Return | osid.process.StateQuery | the discreet state query | |
Errors | UNIMPLEMENTED | supportsDiscreetStateQuery() is false | |
Compliance | optional | This method must be implemented if supportsDiscreetStateQuery()
is true. | |
Method | matchAnyDiscreetState | ||
Description |
Matches triggers with any discreet state. | ||
Parameters | boolean | match | true to match triggers with any discreet state, false
to match triggers with no discreet states |
Compliance | mandatory | This method must be implemented. | |
Method | clearDiscreetStateTerms | ||
Description |
Clears the discreet state query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchActionGroupId | ||
Description |
Sets the action group | ||
Parameters | osid.id.Id | actionGroupId | an action group Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | actionGroupId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearActionGroupIdTerms | ||
Description |
Clears the action group | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsActionGroupQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a action group query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupQuery | ||
Description |
Gets the query for an action group. Multiple retrievals
produce a nested | ||
Return | osid.control.ActionGroupQuery | the action group query | |
Errors | UNIMPLEMENTED | supportsActionGroupQuery() is false | |
Compliance | optional | This method must be implemented if supportsActionGroupQuery()
is true. | |
Method | matchAnyActionGroup | ||
Description |
Matches triggers with any action group. | ||
Parameters | boolean | match | true to match triggers with any action group,, false
to match triggers with no action groups |
Compliance | mandatory | This method must be implemented. | |
Method | clearActionGroupTerms | ||
Description |
Clears the action group query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSceneId | ||
Description |
Sets the scene | ||
Parameters | osid.id.Id | sceneId | a scene Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | sceneId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSceneIdTerms | ||
Description |
Clears the scene | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSceneQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a scene query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneQuery | ||
Description |
Gets the query for a scene. Multiple retrievals produce
a nested | ||
Return | osid.control.SceneQuery | the scene query | |
Errors | UNIMPLEMENTED | supportsSceneQuery() is false | |
Compliance | optional | This method must be implemented if supportsSceneQuery() is
true. | |
Method | matchAnyScene | ||
Description |
Matches triggers with any scene. | ||
Parameters | boolean | match | true to match triggers with any scene, false
to match triggers with no scenes |
Compliance | mandatory | This method must be implemented. | |
Method | clearSceneTerms | ||
Description |
Clears the scene query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSettingId | ||
Description |
Sets the setting | ||
Parameters | osid.id.Id | settingId | a setting Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | settingId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSettingIdTerms | ||
Description |
Clears the setting | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSettingQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a setting query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingQuery | ||
Description |
Gets the query for a setting. Multiple retrievals
produce a nested | ||
Return | osid.control.SettingQuery | the setting query | |
Errors | UNIMPLEMENTED | supportsSettingQuery() is false | |
Compliance | optional | This method must be implemented if supportsSettingQuery() is
true. | |
Method | matchAnySetting | ||
Description |
Matches triggers with any setting. | ||
Parameters | boolean | match | true to match triggers with any setting, false
to match triggers with no settings |
Compliance | mandatory | This method must be implemented. | |
Method | clearSettingTerms | ||
Description |
Clears the setting query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSystemId | ||
Description |
Sets the system | ||
Parameters | osid.id.Id | triggerId | the trigger Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | triggerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSystemIdTerms | ||
Description |
Clears the system | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSystemQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a system query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystemQuery | ||
Description |
Gets the query for a system. Multiple retrievals
produce a nested | ||
Return | osid.control.SystemQuery | the system query | |
Errors | UNIMPLEMENTED | supportsSystemQuery() is false | |
Compliance | optional | This method must be implemented if supportsSystemQuery() is
true. | |
Method | clearSystemTerms | ||
Description |
Clears the system query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerQueryRecord | ||
Description |
Gets the trigger query record corresponding to the
given | ||
Parameters | osid.type.Type | triggerRecordType | a trigger record type |
Return | osid.control.records.TriggerQueryRecord | the trigger query record | |
Errors | NULL_ARGUMENT | triggerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(triggerRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |