org.osid.search

Interface QueryInspector

All Superinterfaces:

OsidQueryInspector

public interface QueryInspector
extends OsidQueryInspector

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.

Method Summary

Methods

Modifier and Type	Method and Description
QueryInspectorRecord	getQueryInspectorRecord(Type queryRecordType) Gets the query inspector record corresponding to the given Query record Type.

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getQueryInspectorRecord

QueryInspectorRecord getQueryInspectorRecord(Type queryRecordType)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

queryRecordType - a query record type

Returns:

the query inspector record

Throws:

NullArgumentException - queryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(queryRecordType) is false

Compliance:

mandatory - This method must be implemented.