OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.EngineQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining engine queries.

MethodgetRuleIdTerms
Description

Gets the rule Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetRuleTerms
Description

Gets the rule query terms.

Returnosid.rules.RuleQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorEngineIdTerms
Description

Gets the ancestor engine Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorEngineTerms
Description

Gets the ancestor engine query terms.

Returnosid.rules.EngineQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantEngineIdTerms
Description

Gets the descendant engine Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantEngineTerms
Description

Gets the descendant engine query terms.

Returnosid.rules.EngineQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetEngineQueryInspectorRecord
Description

Gets the engine query inspector record corresponding to the given Engine record Type.

Parametersosid.type.TypeengineRecordTypean engine record type
Returnosid.rules.records.EngineQueryInspectorRecordthe engine query inspector record
ErrorsNULL_ARGUMENT engineRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(engineRecordType) is false
CompliancemandatoryThis method must be implemented.