Interface Query

All Superinterfaces:

OsidQuery, Suppliable

public interface Query
extends OsidQuery

This is the query interface.

Method Summary

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

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

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.