OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.Plan
Implementsosid.OsidRelationship
Description

A Plan is an OsidRelationship to apply a Syllabus to a CourseOffering. The Plans within a Plan must be to the same Syllabus indicated by the Plan and the CourseOffering must be to the same Course as the Syllabus.

MethodgetSyllabusId
Description

Gets the Id of the syllabus.

Returnosid.id.Idthe syllabus Id
CompliancemandatoryThis method must be implemented.
MethodgetSyllabus
Description

Gets the syllabus.

Returnosid.course.syllabus.Syllabusthe syllabus
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingId
Description

Gets the Id of the course offering.

Returnosid.id.Idthe course offering Id
CompliancemandatoryThis method must be implemented.
MethodgetCourseOffering
Description

Gets the course offering.

Returnosid.course.CourseOfferingthe course offering
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetModuleIds
Description

Gets the modules to apply to this plan.

Returnosid.id.IdListthe module Ids
CompliancemandatoryThis method must be implemented.
MethodgetModules
Description

Gets the modules to apply to this plan.

Returnosid.course.syllabus.ModuleListthe module
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPlanRecord
Description

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

Parametersosid.type.TypeplanRecordTypethe type of plan record to retrieve
Returnosid.course.plan.records.PlanRecordthe plan record
ErrorsNULL_ARGUMENT planRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(planRecordType) is false
CompliancemandatoryThis method must be implemented.