OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnit
Implementsosid.OsidObject
osid.Operable
Description

A Canonical Unit is an approved item to be offered.

MethodgetTitle
Description

Gets the title for this canonical unit.

Returnosid.locale.DisplayTextthe title
CompliancemandatoryThis method must be implemented.
MethodgetCode
Description

Gets the code for this canonical unit.

Returnstringthe code
CompliancemandatoryThis method must be implemented.
MethodgetOfferedCyclicTimePeriodIds
Description

Gets the cyclic period Ids in which this CU can be offered. If there are no time cycles, then it can be offered any time.

Returnosid.id.IdLista list of cyclic period Ids
CompliancemandatoryThis method must be implemented.
MethodgetOfferedCyclicTimePeriods
Description

Gets the cyclic periods in which this CU can be offered. If there are no time cycles, then it can be offered any time.

Returnosid.calendaring.cycle.CyclicTimePeriodLista list of cyclic periods
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasResults
Description

Tests if this canonical has results when offered.

Returnboolean true if this canonical has results, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResultOptionIds
Description

Gets the various result option Ids allowed for results.

Returnosid.id.IdListthe returned list of grading option Ids
ErrorsILLEGAL_STATE hasResults() is false
CompliancemandatoryThis method must be implemented.
MethodgetResultOptions
Description

Gets the various result options allowed for this canonical unit.

Returnosid.grading.GradeSystemListthe returned list of grading options
ErrorsILLEGAL_STATE hasResults() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasSponsors
Description

Tests if this canonical has sponsors.

Returnboolean true if this canonical has sponsors, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSponsorIds
Description

Gets the sponsor Ids.

Returnosid.id.IdListthe sponsor Ids
ErrorsILLEGAL_STATE hasSponsors() is false
CompliancemandatoryThis method must be implemented.
MethodgetSponsors
Description

Gets the sponsors.

Returnosid.resource.ResourceListthe sponsors
ErrorsILLEGAL_STATE hasSponsors() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnitRecord
Description

Gets the record corresponding to the given CanonicalUnit record Type. This method is used to retrieve an object implementing the requested record. The canonicalUnitRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(canonicalUnitRecordType) is true .

Parametersosid.type.TypecanonicalUnitRecordTypethe type of canonical unit record to retrieve
Returnosid.offering.records.CanonicalUnitRecordthe canonical unit record
ErrorsNULL_ARGUMENT canonicalUnitRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(canonicalUnitRecordType) is false
CompliancemandatoryThis method must be implemented.