public interface LessonCourseCatalogSession extends OsidSession
This session provides methods to retrieve Lesson
to
CourseCatalog
mappings. A Lesson
may appear
in multiple Course Catalogs.
Each CourseCatalog
may have its own authorizations governing who is allowed to look
at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupLessonCourseCatalogMappings()
Tests if this user can perform lookups of lesson/course catalog
mappings.
|
IdList |
getCourseCatalogIdsByLesson(Id lessonId)
Gets the list of
CourseCatalog Ids
mapped to a Lesson. |
CourseCatalogList |
getCourseCatalogsByLesson(Id lessonId)
Gets the list of
CourseCatalog objects mapped to a
Lesson. |
IdList |
getLessonIdsByCourseCatalog(Id courseCatalogId)
Gets the list of Lesson Ids associated with an
CourseCatalog. |
IdList |
getLessonIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Lesson Ids corresponding to a list of
CourseCatalog objects. |
LessonList |
getLessonsByCourseCatalog(Id courseCatalogId)
Gets the list of
Lessons associated with an
CourseCatalog. |
LessonList |
getLessonsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Lessons corresponding to a list of
Course Catalogs. |
void |
useComparativeCourseCatalogView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryCourseCatalogView()
A complete view of the
Lesson and CourseCatalog
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupLessonCourseCatalogMappings()
PERMISSION_DENIED.
This is intendedas a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCourseCatalogView()
Lesson
and CourseCatalog
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getLessonIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog.
courseCatalogId
- Id
of an CourseCatalog.
Ids
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Lessons
associated with an
CourseCatalog.
courseCatalogId
- Id
of an CourseCatalog
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getLessonIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Lesson Ids
corresponding to a list of
CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LessonList getLessonsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Lessons
corresponding to a list of
Course Catalogs.
courseCatalogIds
- list of course catalog Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByLesson(Id lessonId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to a Lesson.
lessonId
- Id
of a Lesson
Ids
NotFoundException
- lessonId
is not
foundNullArgumentException
- lessonId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByLesson(Id lessonId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to a
Lesson.
lessonId
- Id
of a Lesson
NotFoundException
- lessonId
is not
foundNullArgumentException
- lessonId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.