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.

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

Method Summary

Modifier and Type	Method	Description
QueryInspectorRecord	getQueryInspectorRecord(Type queryRecordType)	Gets the query inspector record corresponding to the given Query record Type.Multiple record retrievals produce a nested boolean OR term.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Details

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.