OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.QueryInspector
Implementsosid.OsidQueryInspector
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.

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.TypequeryRecordTypea query record type
Returnosid.search.records.QueryInspectorRecordthe query inspector record
ErrorsNULL_ARGUMENT queryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(queryRecordType) is false
CompliancemandatoryThis method must be implemented.