OSID - osid.control.rules.ActionEnablerQuery Service Interface Definition

Interface	osid.control.rules.ActionEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.control.rules.ActionEnablerQuerySession`
	`osid.control.rules.ActionEnablerSearchSession`
	`osid.control.rules.ActionEnablerSmartSystemSession`
Description	This is the query for searching action enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledActionId
Description	Matches enablers mapped to the action.
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	clearRuledActionIdTerms
Description	Clears the action `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledActionQuery
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	getRuledActionQuery
Description	Gets the query for an action. Multiple retrievals produce a nested `OR` term.
Return	`osid.control.ActionQuery`		the action query
Errors	UNIMPLEMENTED		`supportsRuledActionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledActionQuery()` is `true`.
Method	matchAnyRuledAction
Description	Matches enablers mapped to any action.
Parameters	`boolean`	`match`	`true` for enablers mapped to any action, `false` to match enablers mapped to no actions
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledActionTerms
Description	Clears the action query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSystemId
Description	Matches enablers mapped to the system.
Parameters	`osid.id.Id`	`systemId`	the system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`systemId` 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	getActionEnablerQueryRecord
Description	Gets the action enabler query record corresponding to the given `ActionEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`actionEnablerRecordType`	an action enabler record type
Return	`osid.control.rules.records.ActionEnablerQueryRecord`		the action enabler query record
Errors	NULL_ARGUMENT		`actionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(actionEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.