public interface ActionQuery extends OsidRuleQuery, OsidSubjugateableQuery
This is the query for searching actions. 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 |
clearBlockingTerms()
Clears the blocking query terms.
|
void |
clearDelayTerms()
Clears the delay query terms.
|
void |
clearNextActionGroupIdTerms()
Clears the executed action group
Id query terms. |
void |
clearNextActionGroupTerms()
Clears the action group 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.
|
ActionGroupQuery |
getActionGroupQuery()
Gets the query for an action group.
|
ActionQueryRecord |
getActionQueryRecord(Type actionRecordType)
Gets the action query record corresponding to the given
Action
record Type. |
ActionGroupQuery |
getNextActionGroupQuery()
Gets the query for the action group to execute.
|
SceneQuery |
getSceneQuery()
Gets the query for a scene.
|
SettingQuery |
getSettingQuery()
Gets the query for a setting.
|
void |
matchActionGroupId(Id actionGroupId,
boolean match)
Sets the action group
Id for this query. |
void |
matchAnyDelay(boolean match)
Matches any delay.
|
void |
matchAnyNextActionGroup(boolean match)
Matches actions with any executable action group.
|
void |
matchAnyScene(boolean match)
Matches actions with any scene.
|
void |
matchAnySetting(boolean match)
Matches actions with any setting.
|
void |
matchBlocking(boolean match)
Matches blocking actions.
|
void |
matchDelay(Duration start,
Duration end,
boolean match)
Matches delays between the given range inclusive.
|
void |
matchNextActionGroupId(Id actionGroupId,
boolean match)
Sets the executed action group
Id for this query. |
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. |
boolean |
supportsActionGroupQuery()
Tests if an
ActionGroupQuery is available. |
boolean |
supportsNextActionGroupQuery()
Tests if an
ActionGroupQuery is available. |
boolean |
supportsSceneQuery()
Tests if a
SceneQuery is available. |
boolean |
supportsSettingQuery()
Tests if a
SettingQuery 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 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 an 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 clearActionGroupTerms()
mandatory
- This method must be implemented. void matchDelay(Duration start, Duration 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
NullArgumentException
- start or end
is
null
mandatory
- This method must be implemented. void matchAnyDelay(boolean match)
match
- true
to match actions with delays,
false
to match actions with no delaysmandatory
- This method must be implemented. void clearDelayTerms()
mandatory
- This method must be implemented. void matchBlocking(boolean match)
match
- true
to match blocking actions,
false
to match unblocking actionsmandatory
- This method must be implemented. void clearBlockingTerms()
mandatory
- This method must be implemented. void matchNextActionGroupId(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 clearNextActionGroupIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsNextActionGroupQuery()
ActionGroupQuery
is available. true
if an action group query is available,
false
otherwisemandatory
- This method must be implemented. ActionGroupQuery getNextActionGroupQuery()
OR
term.UnimplementedException
-
supportsNextActionGroupQuery()
is false
optional
- This method must be implemented if
supportsNextActionGroupQuery()
is true.
void matchAnyNextActionGroup(boolean match)
match
- true
to match actions with any action
group, false
to match actions with no action
groupsmandatory
- This method must be implemented. void clearNextActionGroupTerms()
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 actions with any scene,
false
to match actions with no scenemandatory
- 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 actions with any setting,
false
to match actions with no settingmandatory
- This method must be implemented. void clearSettingTerms()
mandatory
- This method must be implemented. ActionQueryRecord getActionQueryRecord(Type actionRecordType) throws OperationFailedException
Action
record Type.
Multiple record retrievals produce
a nested OR
term.actionRecordType
- an action record typeNullArgumentException
- actionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionRecordType)
is false
mandatory
- This method must be implemented.