Interface | osid.course.plan.Lesson | ||
---|---|---|---|
Implements | osid.OsidRelationship | ||
Description |
A | ||
Method | getPlanId | ||
Description |
Gets the | ||
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 | ||
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 | ||
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 deteremined by the | ||
Return | osid.calendaring.Duration | the starting time | |
Compliance | mandatory | This method must be implemented. | |
Method | hasBegun | ||
Description |
Tests if this lesson has begun. | ||
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 | ||
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 | |
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
| ||
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 | ||
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 | |
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
| ||
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. |