OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ParticipantQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchOfferingId
Description

Sets an offering Id.

Parametersosid.id.IdofferingIdan offering Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT offeringId is null
CompliancemandatoryThis method must be implemented.
MethodclearOfferingIdTerms
Description

Clears all offering Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOfferingQuery
Description

Tests if an OfferingQuery is available.

Returnboolean true if an offering query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOfferingQuery
Description

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

Returnosid.offering.OfferingQuerythe offering query
ErrorsUNIMPLEMENTED supportsOfferingQuery() is false
ComplianceoptionalThis method must be implemented if supportsOfferingQuery() is true.
MethodclearOfferingTerms
Description

Clears all offering terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResourceId
Description

Sets a resource Id.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears all resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available.

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

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodclearResourceTerms
Description

Clears all resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimePeriodId
Description

Sets the time period Id for this query to match participants that have a related term.

Parametersosid.id.IdtimePeriodIda time period Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT timePeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearTimePeriodIdTerms
Description

Clears the time period Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTimePeriodQuery
Description

Tests if a TimePeriodQuery is available.

Returnboolean true if a time period query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodQuery
Description

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

Returnosid.calendaring.TimePeriodQuerythe time period query
ErrorsUNIMPLEMENTED supportsTimePeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsTimePeriodQuery() is true.
MethodclearTimePeriodTerms
Description

Clears the time period terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResultOptionId
Description

Sets the grade system Id for this query.

Parametersosid.id.IdgradeSystemIda grade system Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeSystemId is null
CompliancemandatoryThis method must be implemented.
MethodclearResultOptionIdTerms
Description

Clears the grade system Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResultOptionQuery
Description

Tests if a GradeSystemQuery is available.

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

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

Returnosid.grading.GradeSystemQuerya grade system query
ErrorsUNIMPLEMENTED supportsResultOptionQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradingOptionQuery() is true.
MethodmatchAnyResultOption
Description

Matches participants that have any grading option.

Parametersbooleanmatch true to match participants with any grading option, false to match participants with no grading options
CompliancemandatoryThis method must be implemented.
MethodclearResultOptionTerms
Description

Clears the grading option terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCatalogueId
Description

Sets the catalogue Id for this query to match participants 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.
MethodgetParticipantQueryRecord
Description

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

Parametersosid.type.TypeparticipantRecordTypea participant record type
Returnosid.offering.records.ParticipantQueryRecordthe participant query record
ErrorsNULL_ARGUMENT participantRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(participantRecordType) is false
CompliancemandatoryThis method must be implemented.