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

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

MethodgetAncestorEngineIdTerms
Description

Gets the ancestor engine Id query terms.

Returnosid.search.terms.IdTerm[]the ancestor engine Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorEngineTerms
Description

Gets the ancestor engine query terms.

Returnosid.search.EngineQueryInspector[]the ancestor engine terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantEngineIdTerms
Description

Gets the descendant engine Id query terms.

Returnosid.search.terms.IdTerm[]the descendant engine Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantEngineTerms
Description

Gets the descendant engine query terms.

Returnosid.search.EngineQueryInspector[]the descendant engine terms
CompliancemandatoryThis method must be implemented.
MethodgetEngineQueryInspectorRecord
Description

Gets the engine query inspector record corresponding to the given Engine record Type. Multiple record retrievals produce a nested boolean OR term.

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