public interface ConferralAcademyAssignmentSession extends OsidSession
This session provides methods to re-assign Conferrals
to
Academies.
A Conferral
may map to multiple
Academies
and removing the last reference to a
Conferral
is the equivalent of deleting it. Each Academy
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of a Conferral
to another
Academy
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignConferralToAcademy(Id conferralId,
Id academyId)
Adds an existing
Conferral to an Academy. |
boolean |
canAssignConferrals()
Tests if this user can alter conferral/academy mappings.
|
boolean |
canAssignConferralsToAcademy(Id academyId)
Tests if this user can alter conferral/academy mappings.
|
IdList |
getAssignableAcademyIds(Id academyId)
Gets a list of academies including and under the given academy node in
which any conferral can be assigned.
|
IdList |
getAssignableAcademyIdsForConferral(Id academyId,
Id conferralId)
Gets a list of academies including and under the given academy node in
which a specific conferral can be assigned.
|
void |
unassignConferralFromAcademy(Id conferralId,
Id academyId)
Removes a
Conferral from an Academy. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignConferrals()
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 canAssignConferralsToAcademy(Id academyId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.academyId
- the Id
of the Academy
false
if mapping is not authorized, true
otherwiseNullArgumentException
- academyId
is
null
mandatory
- This method must be implemented. IdList getAssignableAcademyIds(Id academyId) throws OperationFailedException
academyId
- the Id
of the Academy
Ids
NullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableAcademyIdsForConferral(Id academyId, Id conferralId) throws OperationFailedException
academyId
- the Id
of the Academy
conferralId
- the Id
of the Conferral
Ids
NullArgumentException
- academyId
or
conferralId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignConferralToAcademy(Id conferralId, Id academyId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Conferral
to an Academy.
conferralId
- the Id
of the Conferral
academyId
- the Id
of the Academy
AlreadyExistsException
- conferralId
is
already assigned to academyId
NotFoundException
- conferralId
or
academyId
not foundNullArgumentException
- conferralId
or
academyId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignConferralFromAcademy(Id conferralId, Id academyId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Conferral
from an Academy.
conferralId
- the Id
of the Conferral
academyId
- the Id
of the Academy
NotFoundException
- conferralId
or
academyId
not found or conferralId
not assigned to academyId
NullArgumentException
- conferralId
or
academyId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.