Interface OsidContainableQuery

All Superinterfaces:

OsidQuery, Suppliable

All Known Subinterfaces:

AssessmentPartQuery, CompositionQuery, EventQuery, RecurringEventQuery, ReplyQuery, RequisiteQuery, ScheduleSlotQuery, TodoQuery

public interface OsidContainableQuery
extends OsidQuery

This is the query interface for searching containers. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearSequesteredTerms()	Clears the sequestered query terms.
void	matchSequestered(boolean match)	Match containables that are sequestered.

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

matchSequestered

void matchSequestered(boolean match)

Match containables that are sequestered.

Parameters:

match - true to match any sequestered containables, false to match non-sequestered containables

Compliance:

mandatory - This method must be implemented.

clearSequesteredTerms

void clearSequesteredTerms()

Clears the sequestered query terms.

Compliance:

mandatory - This method must be implemented.