OSID - osid.rules.EngineQueryInspector Service Interface Definition

Interface	osid.rules.EngineQueryInspector
Implements	`osid.OsidCatalogQueryInspector`
Used By	`osid.rules.EngineQueryInspector`
	`osid.rules.EngineSearchResults`
	`osid.rules.RuleQueryInspector`
	`osid.rules.check.AgendaQueryInspector`
	`osid.rules.check.CheckQueryInspector`
	`osid.rules.check.InstructionQueryInspector`
Description	This is the query inspector for examining engine queries.
Method	getRuleIdTerms
Description	Gets the rule `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRuleTerms
Description	Gets the rule query terms.
Return	`osid.rules.RuleQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorEngineIdTerms
Description	Gets the ancestor engine `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorEngineTerms
Description	Gets the ancestor engine query terms.
Return	`osid.rules.EngineQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantEngineIdTerms
Description	Gets the descendant engine `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantEngineTerms
Description	Gets the descendant engine query terms.
Return	`osid.rules.EngineQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getEngineQueryInspectorRecord
Description	Gets the engine query inspector record corresponding to the given `Engine` record `Type`.
Parameters	`osid.type.Type`	`engineRecordType`	an engine record type
Return	`osid.rules.records.EngineQueryInspectorRecord`		the engine query inspector 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.