OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ResultQuery
Implementsosid.OsidObjectQuery
osid.OsidTemporalQuery
osid.OsidSubjugateableQuery
Description

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

MethodmatchParticipantId
Description

Sets a participant Id.

Parametersosid.id.IdparticipantIda participant Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT participantId is null
CompliancemandatoryThis method must be implemented.
MethodclearParticipantIdTerms
Description

Clears all participant Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsParticipantQuery
Description

Tests if a ParticipantUnitQuery is available.

Returnboolean true if a participant query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetParticipantQuery
Description

Gets the query for a participant query. Multiple retrievals produce a nested OR term.

Returnosid.offering.ParticipantQuerythe participant query
ErrorsUNIMPLEMENTED supportsParticipantQuery() is false
ComplianceoptionalThis method must be implemented if supportsParticipantQuery() is true.
MethodclearParticipantTerms
Description

Clears all participant terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradeId
Description

Sets a grade Id.

Parametersosid.id.IdgradeIda grade Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradeIdTerms
Description

Clears all grade Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradeQuery
Description

Tests if a GradetQuery is available.

Returnboolean true if a grade query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeQuery
Description

Gets the query for a grade query. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeQuerythe grade query
ErrorsUNIMPLEMENTED supportsGradeQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradeQuery() is true.
MethodmatchAnyGrade
Description

Matches results with any grade.

Parametersbooleanmatch true to match results with any grade, false to match results with no grade
CompliancemandatoryThis method must be implemented.
MethodclearGradeTerms
Description

Clears all grade terms.

CompliancemandatoryThis method must be implemented.
MethodmatchValue
Description

Matches a value between the given range inclusive.

Parametersdecimalfroma starting range
decimaltoan ending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
CompliancemandatoryThis method must be implemented.
MethodmatchAnyValue
Description

Matches results with any value.

Parametersbooleanmatch true to match results with any value, false to match results with no value
CompliancemandatoryThis method must be implemented.
MethodclearValueTerms
Description

Clears all value terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCatalogueId
Description

Sets the catalogue Id for this query to match results assigned to catalogues.

Parametersosid.id.IdcatalogueIda catalogue Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT catalogueId is null
CompliancemandatoryThis method must be implemented.
MethodclearCatalogueIdTerms
Description

Clears all catalogue Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCatalogueQuery
Description

Tests if a CatalogueQuery is available.

Returnboolean true if a catalogue query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCatalogueQuery
Description

Gets the query for a catalogue query. Multiple retrievals produce a nested OR term.

Returnosid.offering.CatalogueQuerythe catalogue query
ErrorsUNIMPLEMENTED supportsCatalogueQuery() is false
ComplianceoptionalThis method must be implemented if supportsCatalogueQuery() is true.
MethodclearCatalogueTerms
Description

Clears all catalogue terms.

CompliancemandatoryThis method must be implemented.
MethodgetResultQueryRecord
Description

Gets the result query record corresponding to the given Result record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperesultRecordTypean result record type
Returnosid.offering.records.ResultQueryRecordthe result query record
ErrorsNULL_ARGUMENT resultRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resultRecordType) is false
CompliancemandatoryThis method must be implemented.