public interface OsidIdentifiableQuery extends OsidQuery
The OsidIdentiableQuery
is used to assemble search
queries for Identifiable
objects. An
OsidIdentifiableQuery
is available from an OsidQuerySession
and defines methods to match objects. Once the desired parameters
are set, the OsidIdentifiableQuery
is given to the
designated search method. The same OsidIdentifiableQuery
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 |
clearIdTerms()
Clears all
Id terms. |
void |
matchId(Id id,
boolean match)
Adds an
Id to match. |
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchId(Id id, boolean match)
Id
to match. Multiple Ids
can be
added to perform a boolean OR
among them.id
- Id
to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- id
is
null
mandatory
- This method must be implemented. void clearIdTerms()
Id
terms.mandatory
- This method must be implemented.