OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
Description

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

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 canonical units with any title.

Parametersbooleanmatch true to match canonical units with any title, false to match canonical units 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 canonical units with any code.

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

Clears all code terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOfferedCyclicTimePeriodId
Description

Sets the cyclic time period Id for this query.

Parametersosid.id.IdcyclicTimePeriodIda cyclic time period Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cyclicTimePeriodId is null
CompliancemandatoryThis method must be implemented.
MethodclearOfferedCyclicTimePeriodIdTerms
Description

Clears all offered cyclic time period Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOfferedCyclicTimePeriodQuery
Description

Tests if a CyclicTimePeriodQuery is available.

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

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

Returnosid.calendaring.cycle.CyclicTimePeriodQuerythe cyclic time period query
ErrorsUNIMPLEMENTED supportsOfferedCyclicTimePeriodQuery() is false
ComplianceoptionalThis method must be implemented if supportsOfferedCyclicTimePeriodQuery() is true.
MethodmatchAnyOfferedCyclicTimePeriod
Description

Matches canonicals that have any cyclic time period.

Parametersbooleanmatch true to match canonicals with any cyclic time period, false to match canonicals with no cyclic time periods
CompliancemandatoryThis method must be implemented.
MethodclearOfferedCyclicTimePeriodTerms
Description

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

Parametersbooleanmatch true to match canonicals with any grading option, false to match canonicals 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 canonicals 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 canonicals that have any sponsor.

Parametersbooleanmatch true to match canonicals with any sponsor, false to match canonicals 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 canonical units 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.
MethodgetCanonicalUnitQueryRecord
Description

Gets the canonical unit query record corresponding to the given CanonicalUnit record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypecanonicalUnitRecordTypea canonical unit record type
Returnosid.offering.records.CanonicalUnitQueryRecordthe canonical unit query record
ErrorsNULL_ARGUMENT canonicalUnitRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitRecordType) is false
CompliancemandatoryThis method must be implemented.