public interface ActivityRegistrationCourseCatalogSession extends OsidSession
This session provides methods to retrieve ActivityRegistration
to CourseCatalog
mappings. An
ActivityRegistration
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 |
canLookupActivityRegistrationCourseCatalogMappings()
Tests if this user can perform lookups of activity registration/course
catalog mappings.
|
IdList |
getActivityRegistrationIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
ActivityRegistration Ids associated
with a CourseCatalog. |
IdList |
getActivityRegistrationIdsByCourseCatalogs(IdList courseCatalogIdList)
Gets the list of
ActivityRegistration Ids corresponding
to a list of CourseCatalog objects. |
ActivityRegistrationList |
getActivityRegistrationsByCourseCatalog(Id courseCatalogId)
Gets the list of
ActivityRegistrations associated with
a CourseCatalog. |
ActivityRegistrationList |
getActivityRegistrationsByCourseCatalogs(IdList courseCatalogIdList)
Gets the list of
ActivityRegistrations corresponding to
a list of CourseCatalog objects. |
IdList |
getCourseCatalogIdsByActivityRegistration(Id activityRegistrationId)
Gets the
CourseCatalog Ids mapped to an
ActivityRegistration. |
CourseCatalogList |
getCourseCatalogsByActivityRegistration(Id activityRegistrationId)
Gets the
CourseCatalog objects mapped to an
ActivityRegistration. |
void |
useComparativeActivityRegistrationCourseCatalogView()
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 |
usePlenaryActivityRegistrationCourseCatalogView()
A complete view of the
ActivityRegistration and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupActivityRegistrationCourseCatalogMappings()
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 useComparativeActivityRegistrationCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryActivityRegistrationCourseCatalogView()
ActivityRegistration
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 getActivityRegistrationIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityRegistration 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. ActivityRegistrationList getActivityRegistrationsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ActivityRegistrations
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 getActivityRegistrationIdsByCourseCatalogs(IdList courseCatalogIdList) throws OperationFailedException, PermissionDeniedException
ActivityRegistration Ids
corresponding
to a list of CourseCatalog
objects.courseCatalogIdList
- list of course catalog Ids
Ids
NullArgumentException
- courseCatalogIdList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActivityRegistrationList getActivityRegistrationsByCourseCatalogs(IdList courseCatalogIdList) throws OperationFailedException, PermissionDeniedException
ActivityRegistrations
corresponding to
a list of CourseCatalog
objects.courseCatalogIdList
- list of course catalog Ids
NullArgumentException
- courseCatalogIdList
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCourseCatalogIdsByActivityRegistration(Id activityRegistrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to an
ActivityRegistration.
activityRegistrationId
- Id
of an
ActivityRegistration
NotFoundException
- activityRegistrationId
is not foundNullArgumentException
- activityRegistrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByActivityRegistration(Id activityRegistrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to an
ActivityRegistration.
activityRegistrationId
- Id
of an
ActivityRegistration
NotFoundException
- activityRegistrationId
is not foundNullArgumentException
- activityRegistrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.