org.osid.search

Interface Query

All Superinterfaces:

OsidQuery, Suppliable

public interface Query
extends OsidQuery

This is the query interface.

Method Summary

Methods

Modifier and Type	Method and Description
QueryRecord	getQueryRecord(Type queryRecordType) Gets the query record corresponding to the given Query record Type.

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

getQueryRecord

QueryRecord getQueryRecord(Type queryRecordType)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the query 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 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.