public interface ActionGroupQuery extends OsidObjectQuery, OsidAggregateableQuery
This is the query for searching action groups. 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 |
clearActionIdTerms()
Clears the action
Id query terms. |
void |
clearActionTerms()
Clears the action query terms.
|
void |
clearSystemIdTerms()
Clears the system
Id query terms. |
void |
clearSystemTerms()
Clears the system query terms.
|
ActionGroupQueryRecord |
getActionGroupQueryRecord(Type actionGroupRecordType)
Gets the action group query record corresponding to the given
ActionGroup record Type. |
ActionQuery |
getActionQuery()
Gets the query for an action.
|
SystemQuery |
getSystemQuery()
Gets the query for a system.
|
void |
matchActionId(Id actionId,
boolean match)
Sets the action
Id for this query. |
void |
matchAnyAction(boolean match)
Matches action groups with any action.
|
void |
matchSystemId(Id actionGroupId,
boolean match)
Sets the action group
Id for this query to match
controllers assigned to action groups. |
boolean |
supportsActionQuery()
Tests if an
ActionQuery is available. |
boolean |
supportsSystemQuery()
Tests if a
SystemQuery is available. |
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
void matchActionId(Id actionId, boolean match)
Id
for this query.actionId
- the action Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- actionId
is
null
mandatory
- This method must be implemented. void clearActionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsActionQuery()
ActionQuery
is available. true
if an action query is available,
false
otherwisemandatory
- This method must be implemented. ActionQuery getActionQuery()
OR
term.UnimplementedException
- supportsActionQuery()
is false
optional
- This method must be implemented if
supportsActionQuery()
is true.
void matchAnyAction(boolean match)
match
- true
to match action groups with any
action, false
to match action groups with no
actionsmandatory
- This method must be implemented. void clearActionTerms()
mandatory
- This method must be implemented. void matchSystemId(Id actionGroupId, boolean match)
Id
for this query to match
controllers assigned to action groups.actionGroupId
- the action group Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- actionGroupId
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. ActionGroupQueryRecord getActionGroupQueryRecord(Type actionGroupRecordType) throws OperationFailedException
ActionGroup
record Type.
Multiple record
retrievals produce a nested OR
term.actionGroupRecordType
- an action group record typeNullArgumentException
- actionGroupRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionGroupRecordType)
is false
mandatory
- This method must be implemented.