public interface ActivityCourseCatalogSession extends OsidSession
This session provides methods to retrieve Activity
to
CourseCatalog
mappings. An Activity
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 |
canLookupActivityCourseCatalogMappings()
Tests if this user can perform lookups of activity/course catalog
mappings.
|
ActivityList |
getActivitieByCourseCatalog(Id courseCatalogId)
Gets the list of
Activity associated with a
CourseCatalog. |
ActivityList |
getActivitieByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Activities corresponding to a list of
CourseCatalog objects. |
IdList |
getActivityIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
Activity Ids associated with a
CourseCatalog. |
IdList |
getActivityIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
Activity Ids corresponding to a list
of CourseCatalog objects. |
IdList |
getCourseCatalogIdsByActivity(Id activityId)
Gets the
CourseCatalog Ids mapped to an
Activity. |
CourseCatalogList |
getCourseCatalogsByActivity(Id activityId)
Gets the
CourseCatalog objects mapped to an
Activity. |
void |
useComparativeActivityCourseCatalogView()
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 |
usePlenaryActivityCourseCatalogView()
A complete view of the
Activity and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActivityCourseCatalogMappings()
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 useComparativeActivityCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryActivityCourseCatalogView()
Activity
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 getActivityIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Activity 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. ActivityList getActivitieByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Activity
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 getActivityIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Activity Ids
corresponding to a list
of CourseCatalog
objects.courseCatalogIds
- list of catalog Ids
Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityList getActivitieByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
Activities
corresponding to a list of
CourseCatalog
objects.courseCatalogIds
- list of catalog Ids
NullArgumentException
- courseCatalogIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an
Activity.
activityId
- Id
of an Activity
NotFoundException
- activityId
is not
foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByActivity(Id activityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
Activity.
activityId
- Id
of an Activity
NotFoundException
- activityId
is not
foundNullArgumentException
- activityId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.