OSID Logo
OSID Specifications
search package
Version 3.1.0
Interfaceosid.search.QueryInspector
Implementsosid.OsidQueryInspector
Used Byosid.search.SearchResults
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.

Like all OsidQueryInspectors, QueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetQueryInspectorRecord
Description

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

Parametersosid.type.TypequeryRecordType a query record type
Returnosid.search.records.QueryInspectorRecord the query inspector record
ErrorsNULL_ARGUMENT queryRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(queryRecordType) is false
Compliancemandatory This method must be implemented.