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

A Lesson is the application of a Docet to a Plan . The effectiveness of the lesson determines the applicability of the lesson. The lesson includes additional times for the starting and completion of the lesson.

MethodgetPlanId
Description

Gets the Id of the plan.

Returnosid.id.Idthe plan Id
CompliancemandatoryThis method must be implemented.
MethodgetPlan
Description

Gets the plan.

Returnosid.course.plan.Planthe plan
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDocetId
Description

Gets the Id of the docet.

Returnosid.id.Idthe lesson Id
CompliancemandatoryThis method must be implemented.
MethodgetDocet
Description

Gets the docet.

Returnosid.course.syllabus.Docetthe docet
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetActivityIds
Description

Gets the Ids of the activities to which this lesson applies.

Returnosid.id.IdListthe activity Ids
CompliancemandatoryThis method must be implemented.
MethodgetActivities
Description

Gets the activities to which this lesson applies. A Lesson may span multiple scheduled activities.

Returnosid.course.ActivityListthe activities
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetPlannedStartTime
Description

Gets the planned start time within the first activity as deteremined by the Lesson scheduling. The time expressed as a duration relative to the starting time of the first activity.

Returnosid.calendaring.Durationthe starting time
CompliancemandatoryThis method must be implemented.
MethodhasBegun
Description

Tests if this lesson has begun. hasBegun() is true for completed lessons. A lesson in progress is one where hasBegun() is true and isComplete() or isSkipped() is false.

Returnboolean true if this lesson has begun, false if not yet begun
CompliancemandatoryThis method must be implemented.
MethodgetActualStartTime
Description

Gets the actual start time. The time expressed as a duration relative to the starting time of the actual starting activity.

Returnosid.calendaring.Durationthe actual starting time
ErrorsILLEGAL_STATE hasBegun() is false
CompliancemandatoryThis method must be implemented.
MethodgetActualStartingActivityId
Description

Gets the Id of the activity when this lesson actually began.

Returnosid.id.Idthe starting activity Id
ErrorsILLEGAL_STATE hasBegun() is false
CompliancemandatoryThis method must be implemented.
MethodgetActualStartingActivity
Description

Gets the activity when this lesson actually began.

Returnosid.course.Activitythe starting activity
ErrorsOPERATION_FAILEDunable to complete request
ILLEGAL_STATE hasBegun() is false
CompliancemandatoryThis method must be implemented.
MethodisComplete
Description

Tests if this lesson has been marked as completed.

Returnboolean true if this lesson is complete, false if not completed
ErrorsILLEGAL_STATE hasBegun() is false
CompliancemandatoryThis method must be implemented.
MethodisSkipped
Description

Tests if this lesson has been marked as skipped. A skipped lesson may have been partially undertaken but isComplete() remains false.

Returnboolean true if this lesson is skipped, false if not completed
CompliancemandatoryThis method must be implemented.
MethodgetActualEndTime
Description

Gets the actual completion time. The time expressed as a duration relative to the starting time of the ending activity.

Returnosid.calendaring.Durationthe actual end time
ErrorsILLEGAL_STATE isComplete() and isSkipped() is false
CompliancemandatoryThis method must be implemented.
MethodgetActualEndingActivityId
Description

Gets the Id of the activity when this lesson was completed or skipped.

Returnosid.id.Idthe ending activity Id
ErrorsILLEGAL_STATE isComplete() and isSkipped() is false
CompliancemandatoryThis method must be implemented.
MethodgetActualEndingActivity
Description

Gets the activity when this lesson was completed or skipped.

Returnosid.course.Activitythe ending activity
ErrorsOPERATION_FAILEDunable to complete request
ILLEGAL_STATE isComplete() and isSkipped() is false
CompliancemandatoryThis method must be implemented.
MethodgetActualTimeSpent
Description

Gets the actual duration of this lesson if it has completed, in progress, or skipped.

Returnosid.calendaring.Durationthe actual time spent
ErrorsILLEGAL_STATE hasBegun() is false
CompliancemandatoryThis method must be implemented.
MethodgetLessonRecord
Description

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

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