public interface LessonAnchoringSession extends OsidSession
This session provides a way of "anchoring" lessons with a plan.
Lessons
correspond to their corresponding Docents
laid out along the related Activities.
The
LessonAnchor
ties a Lesson
to a specific
Activity
or at a specific time offet within the specific
Activity.
Automatic generation of Lessons
should be constrained
around the LessonAnchors.
Modifier and Type | Method and Description |
---|---|
void |
addLessonAnchor(Id lessonId,
Id activityId,
Duration offset)
Adds a lesson anchor.
|
boolean |
canAnchorLessons()
Tests if this user can anchor lessons.
|
void |
clearLessonAnchorsForLesson(Id lessonId)
Clears all lesson anchors in a lesson.
|
void |
clearLessonAnchorsForLessonByOffset(Id lessonId,
Duration start,
Duration end)
Clears all lesson anchors within the given offset range inclusive.
|
void |
clearLessonAnchorsForPlan(Id planId)
Clears all lesson anchors for an entire plan.
|
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
LessonAnchorList |
getLessonAnchorsForLesson(Id lessonId)
Gets all lesson anchors for a lesson.
|
LessonAnchorList |
getLessonAnchorsForPlan(Id planId)
Gets all lesson anchors for a plan.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAnchorLessons()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if plan anchoring methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. LessonAnchorList getLessonAnchorsForPlan(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
planId
- a plan Id
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonAnchorList getLessonAnchorsForLesson(Id lessonId) throws NotFoundException, OperationFailedException, PermissionDeniedException
lessonId
- a lesson Id
NotFoundException
- lessonId
is not
foundNullArgumentException
- lessonId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addLessonAnchor(Id lessonId, Id activityId, Duration offset) throws NotFoundException, OperationFailedException, PermissionDeniedException
lessonId
- a lesson Id
activityId
- an activity Id
offset
- a time offsetNotFoundException
- lessonId
or
activityId
is not found, or activityId
is not related to lessonId
NullArgumentException
- lessonId, activityId,
or offset
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void clearLessonAnchorsForPlan(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
planId
- a plan Id
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void clearLessonAnchorsForLesson(Id lessonId) throws NotFoundException, OperationFailedException, PermissionDeniedException
lessonId
- a lesson Id
NotFoundException
- lessonId
is not
foundNullArgumentException
- lessonId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void clearLessonAnchorsForLessonByOffset(Id lessonId, Duration start, Duration end) throws NotFoundException, OperationFailedException, PermissionDeniedException
lessonId
- a lesson Id
start
- a starting time offsetend
- an ending time offsetInvalidArgumentException
- start
is
greater than end
NotFoundException
- lessonId
is not
foundNullArgumentException
- lessonId, start,
or end
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.