OSID - osid.course.plan.Lesson Service Interface Definition

Interface	osid.course.plan.Lesson
Implements	`osid.OsidRelationship`
Used By	`osid.course.plan.LessonAdminSession`
	`osid.course.plan.LessonAnchor`
	`osid.course.plan.LessonList`
	`osid.course.plan.LessonLookupSession`
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.
Method	getPlanId
Description	Gets the `Id` of the plan.
Return	`osid.id.Id`		the plan `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getPlan
Description	Gets the plan.
Return	`osid.course.plan.Plan`		the plan
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDocetId
Description	Gets the `Id` of the docet.
Return	`osid.id.Id`		the lesson `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getDocet
Description	Gets the docet.
Return	`osid.course.syllabus.Docet`		the docet
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getActivityIds
Description	Gets the `Ids` of the activities to which this lesson applies.
Return	`osid.id.IdList`		the activity `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getActivities
Description	Gets the activities to which this lesson applies. A Lesson may span multiple scheduled activities.
Return	`osid.course.ActivityList`		the activities
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getPlannedStartTime
Description	Gets the planned start time within the first activity as determined by the `Lesson` scheduling. The time expressed as a duration relative to the starting time of the first activity.
Return	`osid.calendaring.Duration`		the starting time
Compliance	`mandatory`		This method must be implemented.
Method	hasBegun
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`.
Return	`boolean`		`true` if this lesson has begun, `false` if not yet begun
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartTime
Description	Gets the actual start time. The time expressed as a duration relative to the starting time of the actual starting activity.
Return	`osid.calendaring.Duration`		the actual starting time
Errors	ILLEGAL_STATE		`hasBegun()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartingActivityId
Description	Gets the `Id` of the activity when this lesson actually began.
Return	`osid.id.Id`		the starting activity `Id`
Errors	ILLEGAL_STATE		`hasBegun()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getActualStartingActivity
Description	Gets the activity when this lesson actually began.
Return	`osid.course.Activity`		the starting activity
Errors	OPERATION_FAILED		unable to complete request
Errors	ILLEGAL_STATE		`hasBegun()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isComplete
Description	Tests if this lesson has been marked as completed.
Return	`boolean`		`true` if this lesson is complete, `false` if not completed
Errors	ILLEGAL_STATE		`hasBegun()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isSkipped
Description	Tests if this lesson has been marked as skipped. A skipped lesson may have been partially undertaken but `isComplete()` remains `false`.
Return	`boolean`		`true` if this lesson is skipped, `false` if not completed
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndTime
Description	Gets the actual completion time. The time expressed as a duration relative to the starting time of the ending activity.
Return	`osid.calendaring.Duration`		the actual end time
Errors	ILLEGAL_STATE		`isComplete()` and `isSkipped()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndingActivityId
Description	Gets the `Id` of the activity when this lesson was completed or skipped.
Return	`osid.id.Id`		the ending activity `Id`
Errors	ILLEGAL_STATE		`isComplete()` and `isSkipped()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getActualEndingActivity
Description	Gets the activity when this lesson was completed or skipped.
Return	`osid.course.Activity`		the ending activity
Errors	OPERATION_FAILED		unable to complete request
Errors	ILLEGAL_STATE		`isComplete()` and `isSkipped()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getActualTimeSpent
Description	Gets the actual duration of this lesson if it has completed, in progress, or skipped.
Return	`osid.calendaring.Duration`		the actual time spent
Errors	ILLEGAL_STATE		`hasBegun()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLessonRecord
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`.
Parameters	`osid.type.Type`	`lessonRecordType`	the type of lesson record to retrieve
Return	`osid.course.plan.records.LessonRecord`		the lesson record
Errors	NULL_ARGUMENT		`lessonRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(planRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.