public interface SyllabusCourseCatalogSession extends OsidSession
This session provides methods to retrieve Syllabus
to
CourseCatalog
mappings. A Syllabus
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 |
canLookupSyllabusCourseCatalogMappings()
Tests if this user can perform lookups of syllabus/course catalog
mappings.
|
IdList |
getCourseCatalogIdsBySyllabus(Id syllabusId)
Gets the list of
CourseCatalog Ids
mapped to a Syllabus. |
CourseCatalogList |
getCourseCatalogsBySyllabus(Id syllabusId)
Gets the list of
CourseCatalog objects mapped to a
Syllabus. |
SyllabusList |
getSyllabiByCourseCatalog(Id courseCatalogId)
Gets the list of
Syllabi associated with an
CourseCatalog. |
SyllabusList |
getSyllabiByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Syllabi corresponding to a list of
Course Catalogs. |
IdList |
getSyllabusIdsByCourseCatalog(Id courseCatalogId)
Gets the list of Syllabus Ids associated with an
CourseCatalog. |
IdList |
getSyllabusIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Syllabus Ids corresponding to a list
of CourseCatalog objects. |
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
Syllabus and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSyllabusCourseCatalogMappings()
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()
Syllabus
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 getSyllabusIdsByCourseCatalog(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. SyllabusList getSyllabiByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Syllabi
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 getSyllabusIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Syllabus 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. SyllabusList getSyllabiByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Syllabi
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 getCourseCatalogIdsBySyllabus(Id syllabusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to a Syllabus.
syllabusId
- Id
of a Syllabus
Ids
NotFoundException
- syllabusId
is not
foundNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsBySyllabus(Id syllabusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to a
Syllabus.
syllabusId
- Id
of a Syllabus
NotFoundException
- syllabusId
is not
foundNullArgumentException
- syllabusId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.