org.osid.control

Interface ActionQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

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

Method Detail

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 supportsActionGroupQuery() is true.

clearActionGroupTerms

void clearActionGroupTerms()

Clears the action group query terms.

Compliance:

mandatory - This method must be implemented.

matchDelay

void matchDelay(Duration start,
              Duration end,
              boolean match)

Matches delays between the given range 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

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyDelay

void matchAnyDelay(boolean match)

Matches any delay.

Parameters:

match - true to match actions with delays, false to match actions with no delays

Compliance:

mandatory - This method must be implemented.

clearDelayTerms

void clearDelayTerms()

Clears the delay query terms.

Compliance:

mandatory - This method must be implemented.

matchBlocking

void matchBlocking(boolean match)

Matches blocking actions.

Parameters:

match - true to match blocking actions, false to match unblocking actions

Compliance:

mandatory - This method must be implemented.

clearBlockingTerms

void clearBlockingTerms()

Clears the blocking query terms.

Compliance:

mandatory - This method must be implemented.

matchNextActionGroupId

void matchNextActionGroupId(Id actionGroupId,
                          boolean match)

Sets the executed 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.

clearNextActionGroupIdTerms

void clearNextActionGroupIdTerms()

Clears the executed action group Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsNextActionGroupQuery

boolean supportsNextActionGroupQuery()

Tests if an ActionGroupQuery is available.

Returns:

true if an action group query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getNextActionGroupQuery

ActionGroupQuery getNextActionGroupQuery()

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

Returns:

the action group query

Throws:

UnimplementedException - supportsNextActionGroupQuery() is false

Compliance:

optional - This method must be implemented if supportsNextActionGroupQuery() is true.

matchAnyNextActionGroup

void matchAnyNextActionGroup(boolean match)

Matches actions with any executable action group.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearNextActionGroupTerms

void clearNextActionGroupTerms()

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 supportsSceneQuery() is true.

matchAnyScene

void matchAnyScene(boolean match)

Matches actions with any scene.

Parameters:

match - true to match actions with any scene, false to match actions with no scene

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 supportsSettingQuery() is true.

matchAnySetting

void matchAnySetting(boolean match)

Matches actions with any setting.

Parameters:

match - true to match actions with any setting, false to match actions with no setting

Compliance:

mandatory - This method must be implemented.

clearSettingTerms

void clearSettingTerms()

Clears the setting query terms.

Compliance:

mandatory - This method must be implemented.

getActionQueryRecord

ActionQueryRecord getActionQueryRecord(Type actionRecordType)
                                       throws OperationFailedException

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

Parameters:

actionRecordType - an action record type

Returns:

the action query record

Throws:

NullArgumentException - actionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionRecordType) is false

Compliance:

mandatory - This method must be implemented.