public interface RequisiteCourseCatalogSession extends OsidSession
This session provides methods to retrieve Requisite
to
CourseCatalog
mappings. A Requisite
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 |
canLookupCourseCatalogMappings()
Tests if this user can perform lookups of requisite/course catalog
mappings.
|
IdList |
getCourseCatalogIdsByRequisite(Id requisiteId)
Gets the
CourseCatalog Ids mapped to a
Requisite. |
CourseCatalogList |
getCourseCatalogsByRequisite(Id requisiteId)
Gets the
CourseCatalog objects mapped to a
Requisite. |
IdList |
getRequisiteIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
Requisite Ids associated with a
CourseCatalog. |
IdList |
getRequisiteIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Requisite Ids corresponding to a list
of CourseCatalog objects. |
RequisiteList |
getRequisitesByCourseCatalog(Id courseCatalogId)
Gets the list of
Requisites associated with a
CourseCatalog. |
RequisiteList |
getRequisitesByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Requisites 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
Requisite and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCourseCatalogMappings()
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 useComparativeCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryCourseCatalogView()
Requisite
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 getRequisiteIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Requisite 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. RequisiteList getRequisitesByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Requisites
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 getRequisiteIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Requisite 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. RequisiteList getRequisitesByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Requisites
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 getCourseCatalogIdsByRequisite(Id requisiteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to a
Requisite.
requisiteId
- Id
of a pRequisite
Ids
NotFoundException
- requisiteId
is not
foundNullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByRequisite(Id requisiteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to a
Requisite.
requisiteId
- Id
of a Requisite
NotFoundException
- requisiteId
is not
foundNullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.