org.osid.course.plan

Interface LessonAnchor

All Superinterfaces:

OsidCapsule

public interface LessonAnchor
extends OsidCapsule

A LessonAnchor forces a Lesson to begin at the specified Activity and optionally at a specified time.

Method Summary

Methods

Modifier and Type	Method and Description
Activity	getActivity() Gets the activity.
Id	getActivityId() Gets the Id of the activity.
Lesson	getLesson() Gets the lesson.
Id	getLessonId() Gets the Id of the lesson.
Duration	getTime() Gets the time offset from the start of the acttvity where the anchor exists.

Method Detail

getLessonId

Id getLessonId()

Gets the Id of the lesson.

Returns:

the lesson Id

Compliance:

mandatory - This method must be implemented.

getLesson

Lesson getLesson()
                 throws OperationFailedException

Gets the lesson.

Returns:

the lesson

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getActivityId

Id getActivityId()

Gets the Id of the activity.

Returns:

the activity Id

Compliance:

mandatory - This method must be implemented.

getActivity

Activity getActivity()
                     throws OperationFailedException

Gets the activity.

Returns:

the activity

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTime

Duration getTime()

Gets the time offset from the start of the acttvity where the anchor exists.

Returns:

a duration from the start of the activity

Compliance:

mandatory - This method must be implemented.