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

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

MethodmatchCanonicalUnitId
Description

Sets the canonical unit Id for this query.

Parametersosid.id.IdcanonicalUnitIda canonica unitl Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT canonicalUnitId is null
CompliancemandatoryThis method must be implemented.
MethodclearCanonicalUnitIdTerms
Description

Clears the canonical unit Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCanonicalUnitQuery
Description

Tests if a CanonicalUnitQuery is available.

Returnboolean true if a canonical unit query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitQuery
Description

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

Returnosid.offering.CanonicalUnitQuerythe canonical unit query
ErrorsUNIMPLEMENTED supportsCanonicalUnitQuery() is false
ComplianceoptionalThis method must be implemented if supportsCanonicalUnitQuery() is true.
MethodclearCanonicalUnitTerms
Description

Clears the canonical unit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimePeriodId
Description

Sets the time period Id for this query to match offerings 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.
MethodmatchTitle
Description

Matches a title.

Parametersstringtitlea title
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT title is not of stringMatchType
NULL_ARGUMENT title or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTitle
Description

Matches offerings with any title.

Parametersbooleanmatch true to match offerings with any title, false to match offerings with no title
CompliancemandatoryThis method must be implemented.
MethodclearTitleTerms
Description

Clears all title terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCode
Description

Matches a code.

Parametersstringcodea code
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT code is not of stringMatchType
NULL_ARGUMENT code or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCode
Description

Matches offerings with any code.

Parametersbooleanmatch true to match offerings with any code, false to match offerings with no code
CompliancemandatoryThis method must be implemented.
MethodclearCodeTerms
Description

Clears all code 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 offerings that have any grading option.

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

Clears the grading option terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSponsorId
Description

Sets the resource Id for this query to match offerings that have a sponsor.

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

Clears the sponsor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSponsorQuery
Description

Tests if a ResourceQuery is available.

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

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

Returnosid.resource.ResourceQuerya resource query
ErrorsUNIMPLEMENTED supportsSponsorQuery() is false
ComplianceoptionalThis method must be implemented if supportsSponsorQuery() is true.
MethodmatchAnySponsor
Description

Matches offerings that have any sponsor.

Parametersbooleanmatch true to match offerings with any sponsor, false to match offerings with no sponsors
CompliancemandatoryThis method must be implemented.
MethodclearSponsorTerms
Description

Clears the sponsor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCatalogueId
Description

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

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

Parametersosid.type.TypeofferingRecordTypean offering record type
Returnosid.offering.records.OfferingQueryRecordthe offering query record
ErrorsNULL_ARGUMENT offeringRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringRecordType) is false
CompliancemandatoryThis method must be implemented.