public interface OsidExtensibleQuery extends OsidQuery, Extensible
The OsidExtensibleQuery
is used to assemble search
queries for Extensible
objects. An
OsidExtensibleQuery
is available from an OsidQuerySession
and defines methods to match objects. Once the desired parameters
are set, the OsidExtensibleQuery
is given to the designated
search method. The same OsidExtensibleQuery
returned from
the session must be used in the search as the provider may utilize
implementation-specific data wiithin the object.
If multiple data elements are set in this interface, the results matching all the given data (eg: AND) are returned.
Modifier and Type | Method and Description |
---|---|
void |
clearRecordTerms()
Clears all record
Type terms. |
void |
matchAnyRecord(boolean match)
Matches an object that has any record.
|
void |
matchRecordType(Type recordType,
boolean match)
Sets a
Type for querying objects having records
implementing a given record type. |
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
getRecordTypes, hasRecordType
void matchRecordType(Type recordType, boolean match)
Type
for querying objects having records
implementing a given record type.recordType
- a record typematch
- true
for a positive match, false
for a negative matchNullArgumentException
- recordType
is
null
mandatory
- This method must be implemented. void matchAnyRecord(boolean match)
match
- true
to match any record, false
to match objects with no recordsmandatory
- This method must be implemented. void clearRecordTerms()
Type
terms.mandatory
- This method must be implemented.