Interface TriggerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidSubjugateableQuery, Suppliable

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 .

Method Summary

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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(BigDecimal start, 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(BigDecimal start, 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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Method Details

matchControllerId

void matchControllerId(Id controllerId,
 boolean match)

Sets the controller Id for this query.

Parameters:

controllerId - a controller Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - controllerId is null

Compliance:

mandatory - This method must be implemented.

clearControllerIdTerms

void clearControllerIdTerms()

Clears the controller Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsControllerQuery

boolean supportsControllerQuery()

Tests if a ControllerQuery is available.

Returns:

true if a controller query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getControllerQuery

ControllerQuery getControllerQuery()

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

Returns:

the controller query

Throws:

UnimplementedException - supportsControllerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsControllerQuery()} is {@code true} .

clearControllerTerms

void clearControllerTerms()

Clears the controller query terms.

Compliance:

mandatory - This method must be implemented.

matchTurnedOn

void matchTurnedOn(boolean match)

Matches triggers listening for ON events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearTurnedOnTerms

void clearTurnedOnTerms()

Clears the ON event query terms.

Compliance:

mandatory - This method must be implemented.

matchTurnedOff

void matchTurnedOff(boolean match)

Matches triggers listening for OFF events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearTurnedOffTerms

void clearTurnedOffTerms()

Clears the OFF event query terms.

Compliance:

mandatory - This method must be implemented.

matchChangedVariableAmount

void matchChangedVariableAmount(boolean match)

Matches triggers listening for changed amount events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearChangedVariableAmountTerms

void clearChangedVariableAmountTerms()

Clears the changed amount event query terms.

Compliance:

mandatory - This method must be implemented.

matchExceedsVariableAmount

void matchExceedsVariableAmount(BigDecimal start,
 BigDecimal end,
 boolean match)

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

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

matchAnyExceedsVariableAmount

void matchAnyExceedsVariableAmount(boolean match)

Matches triggers with any exceeds variable amount.

Parameters:

match - true to match triggers with any exceeds amount, false to match triggers with no exceeds amount

Compliance:

mandatory - This method must be implemented.

clearExceedsVariableAmountTerms

void clearExceedsVariableAmountTerms()

Clears the exceeds amount event query terms.

Compliance:

mandatory - This method must be implemented.

matchDeceedsVariableAmount

void matchDeceedsVariableAmount(BigDecimal start,
 BigDecimal end,
 boolean match)

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

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

matchAnyDeceedsVariableAmount

void matchAnyDeceedsVariableAmount(boolean match)

Matches triggers with any deceeds variable amount.

Parameters:

match - true to match triggers with any deceeds amount, false to match triggers with no deceeds amount

Compliance:

mandatory - This method must be implemented.

clearDeceedsVariableAmountTerms

void clearDeceedsVariableAmountTerms()

Clears the deceeds amount event query terms.

Compliance:

mandatory - This method must be implemented.

matchChangedDiscreetState

void matchChangedDiscreetState(boolean match)

Matches triggers listening for changed state events.

Parameters:

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearChangedDiscreetStateTerms

void clearChangedDiscreetStateTerms()

Clears the changed state event query terms.

Compliance:

mandatory - This method must be implemented.

matchDiscreetStateId

void matchDiscreetStateId(Id stateId,
 boolean match)

Sets the state Id for this query.

Parameters:

stateId - a state Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearDiscreetStateIdTerms

void clearDiscreetStateIdTerms()

Clears the discreet state Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDiscreetStateQuery

boolean supportsDiscreetStateQuery()

Tests if a StateQuery is available.

Returns:

true if a discreet state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDiscreetStateQuery

StateQuery getDiscreetStateQuery()

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

Returns:

the discreet state query

Throws:

UnimplementedException - supportsDiscreetStateQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDiscreetStateQuery()} is {@code true} .

matchAnyDiscreetState

void matchAnyDiscreetState(boolean match)

Matches triggers with any discreet state.

Parameters:

match - true to match triggers with any discreet state, false to match triggers with no discreet states

Compliance:

mandatory - This method must be implemented.

clearDiscreetStateTerms

void clearDiscreetStateTerms()

Clears the discreet state query terms.

Compliance:

mandatory - This method must be implemented.

matchActionGroupId

void matchActionGroupId(Id actionGroupId,
 boolean match)

Sets the action group Id for this query.

Parameters:

actionGroupId - an action group Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - actionGroupId is null

Compliance:

mandatory - This method must be implemented.

clearActionGroupIdTerms

void clearActionGroupIdTerms()

Clears the action group Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsActionGroupQuery

boolean supportsActionGroupQuery()

Tests if an ActionGroupQuery is available.

Returns:

true if an action group query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActionGroupQuery

ActionGroupQuery getActionGroupQuery()

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

Returns:

the action group query

Throws:

UnimplementedException - supportsActionGroupQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsActionGroupQuery()} is {@code true} .

matchAnyActionGroup

void matchAnyActionGroup(boolean match)

Matches triggers with any action group.

Parameters:

match - true to match triggers with any action group,, false to match triggers with no action groups

Compliance:

mandatory - This method must be implemented.

clearActionGroupTerms

void clearActionGroupTerms()

Clears the action group query terms.

Compliance:

mandatory - This method must be implemented.

matchSceneId

void matchSceneId(Id sceneId,
 boolean match)

Sets the scene Id for this query.

Parameters:

sceneId - a scene Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - sceneId is null

Compliance:

mandatory - This method must be implemented.

clearSceneIdTerms

void clearSceneIdTerms()

Clears the scene Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSceneQuery

boolean supportsSceneQuery()

Tests if a SceneQuery is available.

Returns:

true if a scene query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSceneQuery

SceneQuery getSceneQuery()

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

Returns:

the scene query

Throws:

UnimplementedException - supportsSceneQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSceneQuery()} is {@code true} .

matchAnyScene

void matchAnyScene(boolean match)

Matches triggers with any scene.

Parameters:

match - true to match triggers with any scene, false to match triggers with no scenes

Compliance:

mandatory - This method must be implemented.

clearSceneTerms

void clearSceneTerms()

Clears the scene query terms.

Compliance:

mandatory - This method must be implemented.

matchSettingId

void matchSettingId(Id settingId,
 boolean match)

Sets the setting Id for this query.

Parameters:

settingId - a setting Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - settingId is null

Compliance:

mandatory - This method must be implemented.

clearSettingIdTerms

void clearSettingIdTerms()

Clears the setting Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSettingQuery

boolean supportsSettingQuery()

Tests if a SettingQuery is available.

Returns:

true if a setting query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSettingQuery

SettingQuery getSettingQuery()

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

Returns:

the setting query

Throws:

UnimplementedException - supportsSettingQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSettingQuery()} is {@code true} .

matchAnySetting

void matchAnySetting(boolean match)

Matches triggers with any setting.

Parameters:

match - true to match triggers with any setting, false to match triggers with no settings

Compliance:

mandatory - This method must be implemented.

clearSettingTerms

void clearSettingTerms()

Clears the setting query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id triggerId,
 boolean match)

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

Parameters:

triggerId - the trigger Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - triggerId is null

Compliance:

mandatory - This method must be implemented.

clearSystemIdTerms

void clearSystemIdTerms()

Clears the system Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSystemQuery

boolean supportsSystemQuery()

Tests if a SystemQuery is available.

Returns:

true if a system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSystemQuery

SystemQuery getSystemQuery()

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

Returns:

the system query

Throws:

UnimplementedException - supportsSystemQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSystemQuery()} is {@code true} .

clearSystemTerms

void clearSystemTerms()

Clears the system query terms.

Compliance:

mandatory - This method must be implemented.

getTriggerQueryRecord

TriggerQueryRecord getTriggerQueryRecord(Type triggerRecordType)
                                  throws OperationFailedException

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

Parameters:

triggerRecordType - a trigger record type

Returns:

the trigger query record

Throws:

NullArgumentException - triggerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerRecordType) is false

Compliance:

mandatory - This method must be implemented.