org.osid.control

Interface ActionGroupQuery

All Superinterfaces:

Extensible, OsidAggregateableQuery, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

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.

Method Summary

Methods

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.

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

Method Detail

matchActionId

void matchActionId(Id actionId,
                 boolean match)

Sets the action Id for this query.

Parameters:

actionId - the action Id

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

Throws:

NullArgumentException - actionId is null

Compliance:

mandatory - This method must be implemented.

clearActionIdTerms

void clearActionIdTerms()

Clears the action Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsActionQuery

boolean supportsActionQuery()

Tests if an ActionQuery is available.

Returns:

true if an action query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActionQuery

ActionQuery getActionQuery()

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

Returns:

the action query

Throws:

UnimplementedException - supportsActionQuery() is false

Compliance:

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

matchAnyAction

void matchAnyAction(boolean match)

Matches action groups with any action.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearActionTerms

void clearActionTerms()

Clears the action query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id actionGroupId,
                 boolean match)

Sets the action group Id for this query to match controllers assigned to action groups.

Parameters:

actionGroupId - the 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.

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

clearSystemTerms

void clearSystemTerms()

Clears the system query terms.

Compliance:

mandatory - This method must be implemented.

getActionGroupQueryRecord

ActionGroupQueryRecord getActionGroupQueryRecord(Type actionGroupRecordType)
                                                 throws OperationFailedException

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

Parameters:

actionGroupRecordType - an action group record type

Returns:

the action group query record

Throws:

NullArgumentException - actionGroupRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionGroupRecordType) is false

Compliance:

mandatory - This method must be implemented.