OSID - osid.control.ActionQuery Service Interface Definition

Interface	osid.control.ActionQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidSubjugateableQuery`
Description	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	matchActionGroupId
Description	Sets the action group `Id` for this query.
Parameters	`osid.id.Id`	`actionGroupId`	an 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	clearActionGroupIdTerms
Description	Clears the action group `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActionGroupQuery
Description	Tests if an `ActionGroupQuery` is available.
Return	`boolean`		`true` if an action group query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActionGroupQuery
Description	Gets the query for an action group. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ActionGroupQuery`		the action group query
Errors	UNIMPLEMENTED		`supportsActionGroupQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActionGroupQuery()` is `true.`
Method	clearActionGroupTerms
Description	Clears the action group query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDelay
Description	Matches delays between the given range inclusive.
Parameters	`osid.calendaring.Duration`	`start`	start of range
	`osid.calendaring.Duration`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start or end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDelay
Description	Matches any delay.
Parameters	`boolean`	`match`	`true` to match actions with delays, `false` to match actions with no delays
Compliance	`mandatory`		This method must be implemented.
Method	clearDelayTerms
Description	Clears the delay query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBlocking
Description	Matches blocking actions.
Parameters	`boolean`	`match`	`true` to match blocking actions, `false` to match unblocking actions
Compliance	`mandatory`		This method must be implemented.
Method	clearBlockingTerms
Description	Clears the blocking query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNextActionGroupId
Description	Sets the executed action group `Id` for this query.
Parameters	`osid.id.Id`	`actionGroupId`	an 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	clearNextActionGroupIdTerms
Description	Clears the executed action group `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsNextActionGroupQuery
Description	Tests if an `ActionGroupQuery` is available.
Return	`boolean`		`true` if an action group query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getNextActionGroupQuery
Description	Gets the query for the action group to execute. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ActionGroupQuery`		the action group query
Errors	UNIMPLEMENTED		`supportsNextActionGroupQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsNextActionGroupQuery()` is `true.`
Method	matchAnyNextActionGroup
Description	Matches actions with any executable action group.
Parameters	`boolean`	`match`	`true` to match actions with any action group, `false` to match actions with no action groups
Compliance	`mandatory`		This method must be implemented.
Method	clearNextActionGroupTerms
Description	Clears the action group query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSceneId
Description	Sets the scene `Id` for this query.
Parameters	`osid.id.Id`	`sceneId`	a scene `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`sceneId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSceneIdTerms
Description	Clears the scene `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSceneQuery
Description	Tests if a `SceneQuery` is available.
Return	`boolean`		`true` if a scene query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSceneQuery
Description	Gets the query for a scene. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SceneQuery`		the scene query
Errors	UNIMPLEMENTED		`supportsSceneQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSceneQuery()` is `true.`
Method	matchAnyScene
Description	Matches actions with any scene.
Parameters	`boolean`	`match`	`true` to match actions with any scene, `false` to match actions with no scene
Compliance	`mandatory`		This method must be implemented.
Method	clearSceneTerms
Description	Clears the scene query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSettingId
Description	Sets the setting `Id` for this query.
Parameters	`osid.id.Id`	`settingId`	a setting `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`settingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSettingIdTerms
Description	Clears the setting `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSettingQuery
Description	Tests if a `SettingQuery` is available.
Return	`boolean`		`true` if a setting query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSettingQuery
Description	Gets the query for a setting. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.SettingQuery`		the setting query
Errors	UNIMPLEMENTED		`supportsSettingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSettingQuery()` is `true.`
Method	matchAnySetting
Description	Matches actions with any setting.
Parameters	`boolean`	`match`	`true` to match actions with any setting, `false` to match actions with no setting
Compliance	`mandatory`		This method must be implemented.
Method	clearSettingTerms
Description	Clears the setting query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getActionQueryRecord
Description	Gets the action query record corresponding to the given `Action` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`actionRecordType`	an action record type
Return	`osid.control.records.ActionQueryRecord`		the action query record
Errors	NULL_ARGUMENT		`actionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(actionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.