OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramOffering
Implementsosid.OsidRelationship
Description

A ProgramOffering represents a learning unit offered duing a Term. Scheduling information of a ProgramOffering is maintained at the Activity level resulting in a composite RecurringEvent. A separate Calendar of activities can be made available through orchestration of the Calendaring OSID.

MethodgetProgramId
Description

Gets the canonical program Id associated with this program offering.

Returnosid.id.Idthe program Id
CompliancemandatoryThis method must be implemented.
MethodgetProgram
Description

Gets the canonical program associated with this program offering.

Returnosid.course.program.Programthe program
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTermId
Description

Gets the Id of the Term of this offering.

Returnosid.id.Idthe Term Id
CompliancemandatoryThis method must be implemented.
MethodgetTerm
Description

Gets the Term of this offering.

Returnosid.course.Termthe term
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTitle
Description

Gets the formal title of this program offering. It may be the same as the display name or it may be used to more formally label the program. A display name might be Course 16 where the title is Aeronautics & Astronautics.

Returnosid.locale.DisplayTextthe program title
CompliancemandatoryThis method must be implemented.
MethodgetNumber
Description

Gets the program number which is a label generally used to index the program offering in a catalog, such as 16.

Returnstringthe program number
CompliancemandatoryThis method must be implemented.
MethodhasSponsors
Description

Tests if this program offering has sponsors.

Returnboolean true if this program 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.
MethodgetCompletionRequirementsInfo
Description

Gets the an informational string for the program completion.

Returnosid.locale.DisplayTextthe program completion
CompliancemandatoryThis method must be implemented.
MethodhasCompletionRequirements
Description

Tests if this program has a rule for the program completion.

Returnboolean true if this program has a completion rule, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCompletionRequirementIds
Description

Gets the Requisite Ids for the program completion.

Returnosid.id.IdListthe completion requisite Ids
ErrorsILLEGAL_STATE hasCompletionRequirements() is false
CompliancemandatoryThis method must be implemented.
MethodgetCompletionRequirements
Description

Gets the requisites for the program completion. Each Requisite is an AND term and must be true for the requirements to be satisifed.

Returnosid.course.requisite.RequisiteListthe completion requisites
ErrorsILLEGAL_STATE hasCompletionRequirements() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodearnsCredentials
Description

Tests if completion of this program results in credentials awarded.

Returnboolean true if this program earns credentials, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCredentialIds
Description

Gets the awarded credential Ids.

Returnosid.id.IdListthe returned list of credential Ids
ErrorsILLEGAL_STATE earnsCredentials() is false
CompliancemandatoryThis method must be implemented.
MethodgetCredentials
Description

Gets the awarded credentials.

Returnosid.course.program.CredentialListthe returned list of credentials
ErrorsILLEGAL_STATE earnsCredentials() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodrequiresRegistration
Description

Tests if this program offering requires advanced registration.

Returnboolean true if this progranm offering requires advance registration, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMinimumSeats
Description

Gets the minimum number of students this offering can have.

Returncardinalthe minimum seats
ErrorsILLEGAL_STATE requiresRegistration() is false
CompliancemandatoryThis method must be implemented.
MethodgetMaximumSeats
Description

Gets the maximum number of students this offering can have.

Returncardinalthe maximum seats
ErrorsILLEGAL_STATE requiresRegistration() is false
CompliancemandatoryThis method must be implemented.
MethodgetURL
Description

Gets an external resource, such as a class web site, associated with this offering.

Returnstringa URL string
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingRecord
Description

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

Parametersosid.type.TypeprogramOfferingRecordTypethe type of program offering record to retrieve
Returnosid.course.program.records.ProgramOfferingRecordthe program offering record
ErrorsNULL_ARGUMENT programOfferingRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programOfferingRecordType) is false
CompliancemandatoryThis method must be implemented.