OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.Program
Implementsosid.OsidObject
osid.Operable
Description

A Program represents a canonical program and instantiated for offering through the creation of a ProgramOffering.

MethodgetTitle
Description

Gets the formal title of this program. It may be the same as the display name or it may be used to more formally label the program. 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 in a catalog, such as "16c."

Returnstringthe program number
CompliancemandatoryThis method must be implemented.
MethodhasSponsors
Description

Tests if this program has sponsors.

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

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

Parametersosid.type.TypeprogramRecordTypethe type of program record to retrieve
Returnosid.course.program.records.ProgramRecordthe program record
ErrorsNULL_ARGUMENT programRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programRecordType) is false
CompliancemandatoryThis method must be implemented.