OSID - osid.control.ActionGroupQuery Service Interface Definition

Interface	osid.control.ActionGroupQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidAggregateableQuery`
Used By	`osid.control.ActionGroupQuerySession`
	`osid.control.ActionGroupSearchSession`
	`osid.control.ActionGroupSmartSystemSession`
	`osid.control.ActionQuery`
	`osid.control.SystemQuery`
	`osid.control.TriggerQuery`
Description	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	matchActionId
Description	Sets the action `Id` for this query.
Parameters	`osid.id.Id`	`actionId`	the action `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`actionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActionIdTerms
Description	Clears the action `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActionQuery
Description	Tests if an `ActionQuery` is available.
Return	`boolean`		`true` if an action query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActionQuery
Description	Gets the query for an action. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ActionQuery`		the action query
Errors	UNIMPLEMENTED		`supportsActionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActionQuery()` is `true`.
Method	matchAnyAction
Description	Matches action groups with any action.
Parameters	`boolean`	`match`	`true` to match action groups with any action, `false` to match action groups with no actions
Compliance	`mandatory`		This method must be implemented.
Method	clearActionTerms
Description	Clears the action query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSystemId
Description	Sets the action group `Id` for this query to match controllers assigned to action groups.
Parameters	`osid.id.Id`	`actionGroupId`	the action group `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`actionGroupId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSystemIdTerms
Description	Clears the system `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSystemQuery
Description	Tests if a `SystemQuery` is available.
Return	`boolean`		`true` if a system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSystemQuery
Description	Gets the query for a system. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SystemQuery`		the system query
Errors	UNIMPLEMENTED		`supportsSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSystemQuery()` is `true`.
Method	clearSystemTerms
Description	Clears the system query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupQueryRecord
Description	Gets the action group query record corresponding to the given `ActionGroup` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`actionGroupRecordType`	an action group record type
Return	`osid.control.records.ActionGroupQueryRecord`		the action group query record
Errors	NULL_ARGUMENT		`actionGroupRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(actionGroupRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.