public interface RegistrationCourseCatalogAssignmentSession extends OsidSession
This session provides methods to re-assign Registrations
to CourseCatalog
objects A Registration
may
appear in multiple CourseCatalog
objects and removing the
last reference to a Registration
is the equivalent of
deleting it. Each CourseCatalog
may have its own
authorizations governing who is allowed to operate on it.
Adding a reference of a Registration
to another
CourseCatalog
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRegistrationToCourseCatalog(Id registrationId,
Id courseCatalogId)
Adds an existing
Registration to a
CourseCatalog. |
boolean |
canAssignRegistrations()
Tests if this user can alter registration/course catalog mappings.
|
boolean |
canAssignRegistrationToCourseCatalog(Id courseCatalogId)
Tests if this user can alter registration/course catalog mappings.
|
IdList |
getAssignableCourseCatalogIds(Id courseCatalogId)
Gets a list of course catalogs including and under the given course
catalog node in which any registration can be assigned.
|
IdList |
getAssignableCourseCtalogIdsForRegistration(Id courseCatalogId,
Id registrationId)
Gets a list of course catalogs including and under the given course
catalog node in which a specific registration can be assigned.
|
void |
reassignRegistrationToCourseCatalog(Id registrationId,
Id fromCourseCatalogId,
Id toCourseCatalogId)
Moves a
Registration from one CourseCatalog
to another. |
void |
unassignRegistrationFromCourseCatalog(Id registrationId,
Id courseCatalogId)
Removes a
Registration from a CourseCatalog. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignRegistrations()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer assignment
operations to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignRegistrationToCourseCatalog(Id courseCatalogId)
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users.courseCatalogId
- the Id
of the
CourseCatalog
false
if mapping is not authorized, true
otherwiseNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. IdList getAssignableCourseCatalogIds(Id courseCatalogId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
Ids
NullArgumentException
- courseCatalogId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCourseCtalogIdsForRegistration(Id courseCatalogId, Id registrationId) throws OperationFailedException
courseCatalogId
- the Id
of the
CourseCatalog
registrationId
- the Id
of the
Registration
Ids
NullArgumentException
- courseCatalogId
or registrationId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRegistrationToCourseCatalog(Id registrationId, Id courseCatalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Registration
to a
CourseCatalog.
registrationId
- the Id
of the
Registration
courseCatalogId
- the Id
of the
CourseCatalog
AlreadyExistsException
- registrationId
is already assigned to courseCatalogId
NotFoundException
- registrationId
or
courseCatalogId
not foundNullArgumentException
- registrationId
or courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRegistrationFromCourseCatalog(Id registrationId, Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Registration
from a CourseCatalog.
registrationId
- the Id
of the
Registration
courseCatalogId
- the Id
of the
CourseCatalog
NotFoundException
- registrationId
or
courseCatalogId
not found or
registrationId
not assigned to courseCatalogId
NullArgumentException
- registrationId
or courseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignRegistrationToCourseCatalog(Id registrationId, Id fromCourseCatalogId, Id toCourseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Registration
from one CourseCatalog
to another. Mappings to other CourseCatalogs
are unaffected.registrationId
- the Id
of the
Registration
fromCourseCatalogId
- the Id
of the current
CourseCatalog
toCourseCatalogId
- the Id
of the destination
CourseCatalog
NotFoundException
- registrationId,
fromCourseCatalogId,
or toCourseCatalogId
not found or registrationId
not mapped
to fromCourseCatalogId
NullArgumentException
- registrationId,
fromCourseCatalogId,
or toCourseCatalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.