public interface RegistrationCourseCatalogSession extends OsidSession
This session provides methods to retrieve Registration
to CourseCatalog
mappings. A Registration
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 |
canLookupRegistrationCourseCatalogMappings()
Tests if this user can perform lookups of registration/course catalog
mappings.
|
IdList |
getCourseCatalogIdsByRegistration(Id registrationId)
Gets the
CourseCatalog Ids mapped to a
Registration. |
CourseCatalogList |
getCourseCatalogsByRegistration(Id registrationId)
Gets the
CourseCatalog objects mapped to a
Registration. |
IdList |
getRegistrationIdsByCourseCatalog(Id courseCatalogId)
Gets the list of
Registration Ids associated with a
CourseCatalog. |
IdList |
getRegistrationIdsByCourseCatalogs(IdList courseCatalogIdList)
Gets the list of
Registration Ids corresponding to a
list of CourseCatalog objects. |
RegistrationList |
getRegistrationsByCourseCatalog(Id courseCatalogId)
Gets the list of
Registrations associated with a
CourseCatalog. |
RegistrationList |
getRegistrationsByCourseCatalogs(IdList courseCatalogIdList)
Gets the list of
Registrations corresponding to a list
of CourseCatalog objects. |
void |
useComparativeRegistrationCourseCatalogView()
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 |
usePlenaryRegistrationCourseCatalogView()
A complete view of the
Registration and
CourseCatalog returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupRegistrationCourseCatalogMappings()
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 useComparativeRegistrationCourseCatalogView()
mandatory
- This method is must be implemented. void usePlenaryRegistrationCourseCatalogView()
Registration
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 getRegistrationIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Registration 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. RegistrationList getRegistrationsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Registrations
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 getRegistrationIdsByCourseCatalogs(IdList courseCatalogIdList) throws OperationFailedException, PermissionDeniedException
Registration 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. RegistrationList getRegistrationsByCourseCatalogs(IdList courseCatalogIdList) throws OperationFailedException, PermissionDeniedException
Registrations
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 getCourseCatalogIdsByRegistration(Id registrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
Ids
mapped to a
Registration.
registrationId
- Id
of a Registration
NotFoundException
- registrationId
is
not foundNullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseCatalogList getCourseCatalogsByRegistration(Id registrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseCatalog
objects mapped to a
Registration.
registrationId
- Id
of a Registration
NotFoundException
- registrationId
is
not foundNullArgumentException
- registrationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.