OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.Offering
Implementsosid.OsidRelationship
Description

An Offering is an OsidRelationship between a CanonicalUnit and a TimePeriod.

MethodgetCanonicalUnitId
Description

Gets the Id of the canonical unit.

Returnosid.id.Idthe canonical unit Id
CompliancemandatoryThis method must be implemented.
MethodgetCanonicalUnit
Description

Gets the canonical of this offering.

Returnosid.offering.CanonicalUnitthe canonical unit
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodId
Description

Gets the Id of the time period.

Returnosid.id.Idthe time period Id
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriod
Description

Gets the time period of this offering

Returnosid.calendaring.TimePeriodthe time period
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTitle
Description

Gets the title for this offering.

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

Gets the code for this offering.

Returnstringthe code
CompliancemandatoryThis method must be implemented.
MethodhasResults
Description

Tests if this offering has results when offered.

Returnboolean true if this offering 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 offering.

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 offering has sponsors.

Returnboolean true if this offering 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.
MethodgetScheduleIds
Description

Gets the schedule Ids associated with this offering.

Returnosid.id.IdListthe schedule Ids
CompliancemandatoryThis method must be implemented.
MethodgetSchedules
Description

Gets the schedules associated with this offering.

Returnosid.calendaring.ScheduleListthe schedules
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetOfferingRecord
Description

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

Parametersosid.type.TypeofferingRecordTypethe type of offering record to retrieve
Returnosid.offering.records.OfferingRecordthe offering record
ErrorsNULL_ARGUMENT offeringRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringRecordType) is false
CompliancemandatoryThis method must be implemented.