OSID - osid.rules.EngineQuery Service Interface Definition

Interface	osid.rules.EngineQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.rules.EngineQuery`
	`osid.rules.EngineQuerySession`
	`osid.rules.EngineSearchSession`
	`osid.rules.RuleQuery`
	`osid.rules.check.AgendaQuery`
	`osid.rules.check.CheckQuery`
	`osid.rules.check.InstructionQuery`
Description	This is the query for searching for engines. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuleId
Description	Sets the rule `Id` for this query to match rules assigned to engines.
Parameters	`osid.id.Id`	`ruleId`	a rule `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ruleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuleIdTerms
Description	Clears the rule `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuleQuery
Description	Tests if a rule query is available.
Return	`boolean`		`true` if a rule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuleQuery
Description	Gets the query for a rule.
Return	`osid.rules.RuleQuery`		the rule query
Errors	UNIMPLEMENTED		`supportsRuleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuleQuery()` is `true`.
Method	matchAnyRule
Description	Matches engines with any riule.
Parameters	`boolean`	`match`	`true` to match engines with any rule,, `false` to match engines with no rules
Compliance	`mandatory`		This method must be implemented.
Method	clearRuleTerms
Description	Clears the rule query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorEngineId
Description	Sets the engine `Id` for this query to match engines that have the specified engine as an ancestor.
Parameters	`osid.id.Id`	`engineId`	an engine `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`engineId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorEngineIdTerms
Description	Clears the ancestor engine `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorEngineQuery
Description	Tests if an `EngineQuery` is available.
Return	`boolean`		`true` if an engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorEngineQuery
Description	Gets the query for an engine. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.EngineQuery`		the engine query
Errors	UNIMPLEMENTED		`supportsAncestorEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorEngineQuery()` is `true`.
Method	matchAnyAncestorEngine
Description	Matches engines with any ancestor.
Parameters	`boolean`	`match`	`true` to match engine with any ancestor, `false` to match root engines
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorEngineTerms
Description	Clears the ancestor engine query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantEngineId
Description	Sets the engine `Id` for this query to match engines that have the specified engine as a descendant.
Parameters	`osid.id.Id`	`engineId`	an engine `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`engineId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantEngineIdTerms
Description	Clears the descendant engine `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantEngineQuery
Description	Tests if an `EngineQuery` is available.
Return	`boolean`		`true` if an engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantEngineQuery
Description	Gets the query for an engine. Multiple retrievals produce a nested `OR` term.
Return	`osid.rules.EngineQuery`		the engine query
Errors	UNIMPLEMENTED		`supportsDescendantEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantEngineQuery()` is `true`.
Method	matchAnyDescendantEngine
Description	Matches engines with any descendant.
Parameters	`boolean`	`match`	`true` to match engine with any descendant, `false` to match leaf engines
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantEngineTerms
Description	Clears the descendant engine query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getEngineQueryRecord
Description	Gets the engine query record corresponding to the given `Engine` record `Type` .Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`engineRecordType`	an engine record type
Return	`osid.rules.records.EngineQueryRecord`		the engine query record
Errors	NULL_ARGUMENT		`engineRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(engineRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.