public interface Lesson extends OsidRelationship
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.
Modifier and Type | Method and Description |
---|---|
ActivityList |
getActivities()
Gets the activities to which this lesson applies.
|
IdList |
getActivityIds()
Gets the
Ids of the activities to which this lesson
applies. |
Activity |
getActualEndingActivity()
Gets the activity when this lesson was completed or skipped.
|
Id |
getActualEndingActivityId()
Gets the
Id of the activity when this lesson was
completed or skipped. |
Duration |
getActualEndTime()
Gets the actual completion time.
|
Activity |
getActualStartingActivity()
Gets the activity when this lesson actually began.
|
Id |
getActualStartingActivityId()
Gets the
Id of the activity when this lesson actually
began. |
Duration |
getActualStartTime()
Gets the actual start time.
|
Duration |
getActualTimeSpent()
Gets the actual duration of this lesson if it has completed, in
progress, or skipped.
|
Docet |
getDocet()
Gets the docet.
|
Id |
getDocetId()
Gets the
Id of the docet. |
LessonRecord |
getLessonRecord(Type lessonRecordType)
Gets the lesson record corresponding to the given
Lesson
record Type. |
Plan |
getPlan()
Gets the plan.
|
Id |
getPlanId()
Gets the
Id of the plan. |
Duration |
getPlannedStartTime()
Gets the planned start time within the first activity as deteremined
by the
Lesson scheduling. |
boolean |
hasBegun()
Tests if this lesson has begun.
|
boolean |
isComplete()
Tests if this lesson has been marked as completed.
|
boolean |
isSkipped()
Tests if this lesson has been marked as skipped.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getPlanId()
Id
of the plan. Id
mandatory
- This method must be implemented. Plan getPlan() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getDocetId()
Id
of the docet. Id
mandatory
- This method must be implemented. Docet getDocet() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getActivityIds()
Ids
of the activities to which this lesson
applies. Ids
mandatory
- This method must be implemented. ActivityList getActivities() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Duration getPlannedStartTime()
Lesson
scheduling. The time expressed as a
duration relative to the starting time of the first activity.mandatory
- This method must be implemented. boolean hasBegun()
hasBegun()
is
true
for completed lessons. A lesson in progress is one where
hasBegun()
is true
and
isComplete()
or isSkipped()
is false.
true
if this lesson has begun, false
if not yet begunmandatory
- This method must be implemented. Duration getActualStartTime()
IllegalStateException
- hasBegun()
is
false
mandatory
- This method must be implemented. Id getActualStartingActivityId()
Id
of the activity when this lesson actually
began. Id
IllegalStateException
- hasBegun()
is
false
mandatory
- This method must be implemented. Activity getActualStartingActivity() throws OperationFailedException
OperationFailedException
- unable to complete requestIllegalStateException
- hasBegun()
is
false
mandatory
- This method must be implemented. boolean isComplete()
true
if this lesson is complete, false
if not completedIllegalStateException
- hasBegun()
is
false
mandatory
- This method must be implemented. boolean isSkipped()
isComplete()
remains
false.
true
if this lesson is skipped, false
if not completedmandatory
- This method must be implemented. Duration getActualEndTime()
IllegalStateException
- isComplete()
and
isSkipped()
is false
mandatory
- This method must be implemented. Id getActualEndingActivityId()
Id
of the activity when this lesson was
completed or skipped. Id
IllegalStateException
- isComplete()
and
isSkipped()
is false
mandatory
- This method must be implemented. Activity getActualEndingActivity() throws OperationFailedException
OperationFailedException
- unable to complete requestIllegalStateException
- isComplete()
and
isSkipped()
is false
mandatory
- This method must be implemented. Duration getActualTimeSpent()
IllegalStateException
- hasBegun()
is
false
mandatory
- This method must be implemented. LessonRecord getLessonRecord(Type lessonRecordType) throws OperationFailedException
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
.lessonRecordType
- the type of lesson record to retrieveNullArgumentException
- lessonRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(planRecordType)
is false
mandatory
- This method must be implemented.