public interface TriggerQuery extends OsidRuleQuery, OsidSubjugateableQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearActionGroupIdTerms()
Clears the action group
Id query terms. |
void |
clearActionGroupTerms()
Clears the action group query terms.
|
void |
clearChangedDiscreetStateTerms()
Clears the changed state event query terms.
|
void |
clearChangedVariableAmountTerms()
Clears the changed amount event query terms.
|
void |
clearControllerIdTerms()
Clears the controller
Id query terms. |
void |
clearControllerTerms()
Clears the controller query terms.
|
void |
clearDeceedsVariableAmountTerms()
Clears the deceeds amount event query terms.
|
void |
clearDiscreetStateIdTerms()
Clears the discreet state
Id query terms. |
void |
clearDiscreetStateTerms()
Clears the discreet state query terms.
|
void |
clearExceedsVariableAmountTerms()
Clears the exceeds amount event query terms.
|
void |
clearSceneIdTerms()
Clears the scene
Id query terms. |
void |
clearSceneTerms()
Clears the scene query terms.
|
void |
clearSettingIdTerms()
Clears the setting
Id query terms. |
void |
clearSettingTerms()
Clears the setting query terms.
|
void |
clearSystemIdTerms()
Clears the system
Id query terms. |
void |
clearSystemTerms()
Clears the system query terms.
|
void |
clearTurnedOffTerms()
Clears the OFF event query terms.
|
void |
clearTurnedOnTerms()
Clears the ON event query terms.
|
ActionGroupQuery |
getActionGroupQuery()
Gets the query for an action group.
|
ControllerQuery |
getControllerQuery()
Gets the query for a controller.
|
StateQuery |
getDiscreetStateQuery()
Gets the query for a discreet state.
|
SceneQuery |
getSceneQuery()
Gets the query for a scene.
|
SettingQuery |
getSettingQuery()
Gets the query for a setting.
|
SystemQuery |
getSystemQuery()
Gets the query for a system.
|
TriggerQueryRecord |
getTriggerQueryRecord(Type triggerRecordType)
Gets the trigger query record corresponding to the given
Trigger record Type. |
void |
matchActionGroupId(Id actionGroupId,
boolean match)
Sets the action group
Id for this query. |
void |
matchAnyActionGroup(boolean match)
Matches triggers with any action group.
|
void |
matchAnyDeceedsVariableAmount(boolean match)
Matches triggers with any deceeds variable amount.
|
void |
matchAnyDiscreetState(boolean match)
Matches triggers with any discreet state.
|
void |
matchAnyExceedsVariableAmount(boolean match)
Matches triggers with any exceeds variable amount.
|
void |
matchAnyScene(boolean match)
Matches triggers with any scene.
|
void |
matchAnySetting(boolean match)
Matches triggers with any setting.
|
void |
matchChangedDiscreetState(boolean match)
Matches triggers listening for changed state events.
|
void |
matchChangedVariableAmount(boolean match)
Matches triggers listening for changed amount events.
|
void |
matchControllerId(Id controllerId,
boolean match)
Sets the controller
Id for this query. |
void |
matchDeceedsVariableAmount(java.math.BigDecimal start,
java.math.BigDecimal end,
boolean match)
Matches triggers listening for deceeds amount events between the given
values inclusive.
|
void |
matchDiscreetStateId(Id stateId,
boolean match)
Sets the state
Id for this query. |
void |
matchExceedsVariableAmount(java.math.BigDecimal start,
java.math.BigDecimal end,
boolean match)
Matches triggers listening for exceeds amount events between the given
values inclusive.
|
void |
matchSceneId(Id sceneId,
boolean match)
Sets the scene
Id for this query. |
void |
matchSettingId(Id settingId,
boolean match)
Sets the setting
Id for this query. |
void |
matchSystemId(Id triggerId,
boolean match)
Sets the system
Id for this query to match triggers
assigned to systems. |
void |
matchTurnedOff(boolean match)
Matches triggers listening for OFF events.
|
void |
matchTurnedOn(boolean match)
Matches triggers listening for ON events.
|
boolean |
supportsActionGroupQuery()
Tests if an
ActionGroupQuery is available. |
boolean |
supportsControllerQuery()
Tests if a
ControllerQuery is available. |
boolean |
supportsDiscreetStateQuery()
Tests if a
StateQuery is available. |
boolean |
supportsSceneQuery()
Tests if a
SceneQuery is available. |
boolean |
supportsSettingQuery()
Tests if a
SettingQuery is available. |
boolean |
supportsSystemQuery()
Tests if a
SystemQuery is available. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchControllerId(Id controllerId, boolean match)
Id
for this query.controllerId
- a controller Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- controllerId
is
null
mandatory
- This method must be implemented. void clearControllerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsControllerQuery()
ControllerQuery
is available. true
if a controller query is available,
false
otherwisemandatory
- This method must be implemented. ControllerQuery getControllerQuery()
OR
term.UnimplementedException
-
supportsControllerQuery()
is false
optional
- This method must be implemented if
supportsControllerQuery()
is true.
void clearControllerTerms()
mandatory
- This method must be implemented. void matchTurnedOn(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearTurnedOnTerms()
mandatory
- This method must be implemented. void matchTurnedOff(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearTurnedOffTerms()
mandatory
- This method must be implemented. void matchChangedVariableAmount(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearChangedVariableAmountTerms()
mandatory
- This method must be implemented. void matchExceedsVariableAmount(java.math.BigDecimal start, java.math.BigDecimal end, boolean match)
start
- start of rangeend
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
mandatory
- This method must be implemented. void matchAnyExceedsVariableAmount(boolean match)
match
- true
to match triggers with any exceeds
amount, false
to match triggers with no exceeds
amountmandatory
- This method must be implemented. void clearExceedsVariableAmountTerms()
mandatory
- This method must be implemented. void matchDeceedsVariableAmount(java.math.BigDecimal start, java.math.BigDecimal end, boolean match)
start
- start of rangeend
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
mandatory
- This method must be implemented. void matchAnyDeceedsVariableAmount(boolean match)
match
- true
to match triggers with any deceeds
amount, false
to match triggers with no deceeds
amountmandatory
- This method must be implemented. void clearDeceedsVariableAmountTerms()
mandatory
- This method must be implemented. void matchChangedDiscreetState(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearChangedDiscreetStateTerms()
mandatory
- This method must be implemented. void matchDiscreetStateId(Id stateId, boolean match)
Id
for this query.stateId
- a state Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stateId
is
null
mandatory
- This method must be implemented. void clearDiscreetStateIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDiscreetStateQuery()
StateQuery
is available. true
if a discreet state query is available,
false
otherwisemandatory
- This method must be implemented. StateQuery getDiscreetStateQuery()
OR
term.UnimplementedException
-
supportsDiscreetStateQuery()
is false
optional
- This method must be implemented if
supportsDiscreetStateQuery()
is true.
void matchAnyDiscreetState(boolean match)
match
- true
to match triggers with any discreet
state, false
to match triggers with no discreet
statesmandatory
- This method must be implemented. void clearDiscreetStateTerms()
mandatory
- This method must be implemented. void matchActionGroupId(Id actionGroupId, boolean match)
Id
for this query.actionGroupId
- an action group Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- actionGroupId
is
null
mandatory
- This method must be implemented. void clearActionGroupIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsActionGroupQuery()
ActionGroupQuery
is available. true
if a action group query is available,
false
otherwisemandatory
- This method must be implemented. ActionGroupQuery getActionGroupQuery()
OR
term.UnimplementedException
-
supportsActionGroupQuery()
is false
optional
- This method must be implemented if
supportsActionGroupQuery()
is true.
void matchAnyActionGroup(boolean match)
match
- true
to match triggers with any action
group,, false
to match triggers with no action
groupsmandatory
- This method must be implemented. void clearActionGroupTerms()
mandatory
- This method must be implemented. void matchSceneId(Id sceneId, boolean match)
Id
for this query.sceneId
- a scene Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- sceneId
is
null
mandatory
- This method must be implemented. void clearSceneIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsSceneQuery()
SceneQuery
is available. true
if a scene query is available,
false
otherwisemandatory
- This method must be implemented. SceneQuery getSceneQuery()
OR
term.UnimplementedException
- supportsSceneQuery()
is false
optional
- This method must be implemented if
supportsSceneQuery()
is true.
void matchAnyScene(boolean match)
match
- true
to match triggers with any scene,
false
to match triggers with no scenesmandatory
- This method must be implemented. void clearSceneTerms()
mandatory
- This method must be implemented. void matchSettingId(Id settingId, boolean match)
Id
for this query.settingId
- a setting Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- settingId
is
null
mandatory
- This method must be implemented. void clearSettingIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsSettingQuery()
SettingQuery
is available. true
if a setting query is available,
false
otherwisemandatory
- This method must be implemented. SettingQuery getSettingQuery()
OR
term.UnimplementedException
- supportsSettingQuery()
is false
optional
- This method must be implemented if
supportsSettingQuery()
is true.
void matchAnySetting(boolean match)
match
- true
to match triggers with any setting,
false
to match triggers with no settingsmandatory
- This method must be implemented. void clearSettingTerms()
mandatory
- This method must be implemented. void matchSystemId(Id triggerId, boolean match)
Id
for this query to match triggers
assigned to systems.triggerId
- the trigger Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- triggerId
is
null
mandatory
- This method must be implemented. void clearSystemIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsSystemQuery()
SystemQuery
is available. true
if a system query is available,
false
otherwisemandatory
- This method must be implemented. SystemQuery getSystemQuery()
OR
term.UnimplementedException
- supportsSystemQuery()
is false
optional
- This method must be implemented if
supportsSystemQuery()
is true.
void clearSystemTerms()
mandatory
- This method must be implemented. TriggerQueryRecord getTriggerQueryRecord(Type triggerRecordType) throws OperationFailedException
Trigger
record Type.
Multiple record retrievals
produce a nested OR
term.triggerRecordType
- a trigger record typeNullArgumentException
- triggerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(triggerRecordType)
is false
mandatory
- This method must be implemented.