public interface ActivityUnitCourseCatalogSession extends OsidSession
This session provides methods to retrieve ActivityUnit
to CourseCatalog
mappings. An ActivityUnit
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 |
canLookupActivityUnitCourseCatalogMappings()
Tests if this user can perform lookups of activity unit/course catalog
mappings.
|
IdList |
getActivityUnitIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
ActivityUnit Ids associated with a
CourseCatalog. |
IdList |
getActivityUnitIdsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
ActivityUnit Ids corresponding to a
list of CourseCatalog objects. |
ActivityUnitList |
getActivityUnitsByCourseCatalog(Id courseCatalogId)
Gets the list of
ActivityUnits associated with a
CourseCatalog. |
ActivityUnitList |
getActivityUnitsByCourseCatalogs(IdList courseCatalogIds)
Gets the list of
ActivityUnits corresponding to a list
of CourseCatalog objects. |
IdList |
getCourseCatalogIdsByActivityUnit(Id activityUnitId)
Gets the
CourseCatalog Ids mapped to an
ActivityUnit. |
CourseCatalogList |
getCourseCatalogsByActivityUnit(Id activityUnitId)
Gets the
CourseCatalog objects mapped to an
ActivityUnit. |
void |
useComparativeActivityUnitCourseCatalogView()
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 |
usePlenaryActivityUnitCatalogView()
A complete view of the
ActivityUnit and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActivityUnitCourseCatalogMappings()
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 useComparativeActivityUnitCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryActivityUnitCatalogView()
ActivityUnit
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 getActivityUnitIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityUnit 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. ActivityUnitList getActivityUnitsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityUnits
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 getActivityUnitIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
ActivityUnit 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. ActivityUnitList getActivityUnitsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
ActivityUnits
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 getCourseCatalogIdsByActivityUnit(Id activityUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an
ActivityUnit.
activityUnitId
- Id
of an ActivityUnit
NotFoundException
- activityUnitId
is
not foundNullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByActivityUnit(Id activityUnitId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
ActivityUnit.
activityUnitId
- Id
of an ActivityUnit
NotFoundException
- activityUnitId
is
not foundNullArgumentException
- activityUnitId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.