public interface LessonConflictSession 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 |
---|---|
boolean |
canAnchorLessons()
Tests if this user can anchor lessons.
|
ActivityList |
getActivitiesWithLessonGaps(Id planId)
Gets a list of activities with lesson gaps.
|
IdList |
getActivityIdsWithLessonGaps(Id planId)
Gets a list of activity
Ids with lesson gaps or missing
lessons. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
IdList |
getEndingOffsetLessonIds(Id planId)
Gets a list of lesson
Ids that do not end at the end of
an activity. |
LessonList |
getEndingOffsetLessons(Id planId)
Gets a list of lessons that do not end at the end of an activity.
|
LessonList |
getLessonsForPlan(Id planId)
Gets all lessons for a plan.
|
IdList |
getOverlappingLessonIds(Id planId)
Gets a list of overlapping lessons.
|
LessonList |
getOverlappingLessons(Id planId)
Gets a list of overlapping lessons.
|
IdList |
getStartingOffsetLessonIds(Id planId)
Gets a list of lesson
Ids that do not begin at the
start of an activity. |
LessonList |
getStartingOffsetLessons(Id planId)
Gets a list of lessons that do not begin at the start of an activity.
|
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. LessonList getLessonsForPlan(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. IdList getOverlappingLessonIds(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
planId
- a plan Id
Ids
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getOverlappingLessons(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. IdList getStartingOffsetLessonIds(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ids
that do not begin at the
start of an activity.planId
- a plan Id
Ids
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getStartingOffsetLessons(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. IdList getEndingOffsetLessonIds(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ids
that do not end at the end of
an activity.planId
- a plan Id
Ids
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getEndingOffsetLessons(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. IdList getActivityIdsWithLessonGaps(Id planId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ids
with lesson gaps or missing
lessons.planId
- a plan Id
Ids
NotFoundException
- planId
is not foundNullArgumentException
- planId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityList getActivitiesWithLessonGaps(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.