public interface ActivityBundleCourseCatalogSession extends OsidSession
This session provides methods to retrieve ActivityBundle
to CourseCatalog
mappings. An ActivityBundle
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 |
canLookupActivityBundleCourseCatalogMappings()
Tests if this user can perform lookups of activity bundle/course
catalog mappings.
|
IdList |
getActivityBundleIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
ActivityBundle Ids associated with a
CourseCatalog. |
IdList |
getActivityBundleIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
ActivityBundle Ids corresponding to a
list of CourseCatalog objects. |
ActivityBundleList |
getActivityBundlesByCourseCatalog(Id courseCatalogId)
Gets the list of
ActivityBundles associated with a
CourseCatalog. |
ActivityBundleList |
getActivityBundlesByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
ActivityBundles corresponding to a
list of CourseCatalog objects. |
IdList |
getCourseCatalogIdsByActivityBundle(Id activityBundleId)
Gets the
CourseCatalog Ids mapped to an
ActivityBundle. |
CourseCatalogList |
getCourseCatalogsByActivityBundle(Id activityBundleId)
Gets the
CourseCatalog objects mapped to an
ActivityBundle. |
void |
useComparativeActivityBundleCourseCatalogView()
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 |
usePlenaryActivityBundleCourseCatalogView()
A complete view of the
ActivityBundle and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActivityBundleCourseCatalogMappings()
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 useComparativeActivityBundleCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryActivityBundleCourseCatalogView()
ActivityBundle
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 getActivityBundleIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityBundle 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. ActivityBundleList getActivityBundlesByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityBundles
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 getActivityBundleIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
ActivityBundle Ids
corresponding to a
list of CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
Ids
NullArgumentException
- courseCatalogIdList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityBundleList getActivityBundlesByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
ActivityBundles
corresponding to a
list of CourseCatalog
objects.courseCatalogIds
- list of course catalog Ids
NullArgumentException
- courseCatalogIdList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByActivityBundle(Id activityBundleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an
ActivityBundle.
activityBundleId
- Id
of an ActivityBundle
NotFoundException
- activityBundleId
is
not foundNullArgumentException
- activityBundleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByActivityBundle(Id activityBundleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
ActivityBundle.
activityBundleId
- Id
of an ActivityBundle
NotFoundException
- activityBundleId
is
not foundNullArgumentException
- activityBundleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.