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

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.

MethodmatchRecordType
Description

Sets a Type for querying objects having records implementing a given record type.

Parametersosid.type.TyperecordTypea record type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT recordType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyRecord
Description

Matches an object that has any record.

Parametersbooleanmatch true to match any record, false to match objects with no records
CompliancemandatoryThis method must be implemented.
MethodclearRecordTerms
Description

Clears all record Type terms.

CompliancemandatoryThis method must be implemented.