public interface CourseCourseCatalogSession extends OsidSession
This session provides methods to retrieve Course
to
CourseCatalog
mappings. A Course
may appear
in multiple CourseCatalog
objects. Each catalog 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 |
canLookupCourseCourseCatalogMappings()
Tests if this user can perform lookups of course/course catalog
mappings.
|
IdList |
getCourseCatalogIdsByCourse(Id courseId)
Gets the
CourseCatalog Ids mapped to a
Course. |
CourseCatalogList |
getCourseCatalogsByCourse(Id courseId)
Gets the
CourseCatalog objects mapped to a
Course. |
IdList |
getCourseIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
Course Ids associated with a
CourseCatalog. |
IdList |
getCourseIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Course Ids corresponding to a list of
CourseCatalog objects. |
CourseList |
getCoursesByCourseCatalog(Id courseCatalogId)
Gets the list of
Courses associated with a
CourseCatalog. |
CourseList |
getCoursesByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Courses corresponding to a list of
CourseCatalog objects. |
void |
useComparativeCourseCourseCatalogView()
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 |
usePlenaryCourseCourseCatalogView()
A complete view of the
Course and CourseCatalog
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCourseCourseCatalogMappings()
PERMISSION_DENIED.
This is intended as 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 useComparativeCourseCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCourseCourseCatalogView()
Course
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 getCourseIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Course Ids
associated with a
CourseCatalog.
courseCatalogId
- Id
of the CourseCatalog
Ids
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseList getCoursesByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Courses
associated with a
CourseCatalog.
courseCatalogId
- Id
of the CourseCatalog
NotFoundException
- courseCatalogId
is
not foundNullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Course 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. CourseList getCoursesByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Courses
corresponding to a list of
CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByCourse(Id courseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to a
Course.
courseId
- Id
of a Course
Ids
NotFoundException
- courseId
is not
foundNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByCourse(Id courseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to a
Course.
courseId
- Id
of a Course
NotFoundException
- courseId
is not
foundNullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.