public interface DocetCourseCatalogSession extends OsidSession
This session provides methods to retrieve Docet
to
CourseCatalog
mappings. An Docet
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 |
canLookupDocetCourseCatalogMappings()
Tests if this user can perform lookups of docet/course catalog
mappings.
|
IdList |
getCourseCatalogIdsByDocet(Id docetId)
Gets the list of
CourseCatalog Ids
mapped to an Docet. |
CourseCatalogList |
getCourseCatalogsByDocet(Id docetId)
Gets the list of
CourseCatalog objects mapped to an
Docet. |
IdList |
getDocetIdsByCourseCatalog(Id courseCatalogId)
Gets the list of Docet Ids associated with an
CourseCatalog. |
IdList |
getDocetIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Docet Ids corresponding to a list of
CourseCatalog objects. |
DocetList |
getDocetsByCourseCatalog(Id courseCatalogId)
Gets the list of
Docets associated with an
CourseCatalog. |
DocetList |
getDocetsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Docets 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
Docet and CourseCatalog
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupDocetCourseCatalogMappings()
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()
Docet
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 getDocetIdsByCourseCatalog(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. DocetList getDocetsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Docets
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 getDocetIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Docet 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. DocetList getDocetsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Docets
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 getCourseCatalogIdsByDocet(Id docetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an Docet.
docetId
- Id
of an Docet
Ids
NotFoundException
- docetId
is not foundNullArgumentException
- docetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByDocet(Id docetId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
Docet.
docetId
- Id
of an Docet
NotFoundException
- docetId
is not foundNullArgumentException
- docetId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.