OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidIdentifiableQuery
Implementsosid.OsidQuery
Description

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.

MethodmatchId
Description

Adds an Id to match. Multiple Ids can be added to perform a boolean OR among them.

Parametersosid.id.Idid Id to match
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT id is null
CompliancemandatoryThis method must be implemented.
MethodclearIdTerms
Description

Clears all Id terms.

CompliancemandatoryThis method must be implemented.