public interface HoldEnablerOublietteAssignmentSession extends OsidSession
This session provides methods to re-assign HoldEnabler
to Oubliette
mappings. A HoldEnabler
may
appear in multiple Oubliette
objects and removing the last
reference to a HoldEnabler
is the equivalent of deleting
it. Each Hold
may have its own authorizations governing who
is allowed to operate on it.
Adding a reference of a HoldEnabler
to another
Oubliette
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignHoldEnablerToOubliette(Id holdEnablerId,
Id oublietteId)
Adds an existing
HoldEnabler to a Oubliette. |
boolean |
canAssignHoldEnablers()
Tests if this user can alter hold enabler/oubliette mappings.
|
boolean |
canAssignHoldEnablersToOubliette(Id oublietteId)
Tests if this user can alter hold enabler/oubliette mappings.
|
IdList |
getAssignableOublietteIds(Id oublietteId)
Gets a list of oubliettes including and under the given oubliette node
in which any oubliette enabler can be assigned.
|
IdList |
getAssignableOublietteIdsForHoldEnabler(Id oublietteId,
Id holdEnablerId)
Gets a list of oubliettes including and under the given oubliette node
in which a specific oubliette enabler can be assigned.
|
void |
reassignHoldEnablerToOubliette(Id holdEnablerId,
Id fromOublietteId,
Id toOublietteId)
Moves a
HoldEnabler from one Oubliette
to another. |
void |
unassignHoldEnablerFromOubliette(Id holdEnablerId,
Id oublietteId)
Removes a
HoldEnabler from a Oubliette. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignHoldEnablers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignHoldEnablersToOubliette(Id oublietteId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.oublietteId
- the Id
of the Oubliette
false
if mapping is not authorized, true
otherwiseNullArgumentException
- oublietteId
is
null
mandatory
- This method must be implemented. IdList getAssignableOublietteIds(Id oublietteId) throws OperationFailedException
oublietteId
- the Id
of the Oubliette
Ids
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableOublietteIdsForHoldEnabler(Id oublietteId, Id holdEnablerId) throws OperationFailedException
oublietteId
- the Id
of the Oubliette
holdEnablerId
- the Id
of the HoldEnabler
Ids
NullArgumentException
- oublietteId
or
holdEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignHoldEnablerToOubliette(Id holdEnablerId, Id oublietteId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler
to a Oubliette.
holdEnablerId
- the Id
of the HoldEnabler
oublietteId
- the Id
of the Oubliette
AlreadyExistsException
- holdEnablerId
is already assigned to oublietteId
NotFoundException
- holdEnablerId
or
oublietteId
not foundNullArgumentException
- holdEnablerId
or
oublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignHoldEnablerFromOubliette(Id holdEnablerId, Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler
from a Oubliette.
holdEnablerId
- the Id
of the HoldEnabler
oublietteId
- the Id
of the Oubliette
NotFoundException
- holdEnablerId
or
oublietteId
not found or holdEnablerId
is not assigned to oublietteId
NullArgumentException
- holdEnablerId
or
oublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignHoldEnablerToOubliette(Id holdEnablerId, Id fromOublietteId, Id toOublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler
from one Oubliette
to another. Mappings to other Oubliettes
are
unaffected.holdEnablerId
- the Id
of the HoldEnabelr
fromOublietteId
- the Id
of the current
Oubliette
toOublietteId
- the Id
of the destination
Oubliette
NotFoundException
- holdEnabler,
fromOublietteId,
or toOublietteId
not
found or holdEnablerId
not mapped to
fromOublietteId
NullArgumentException
- holdEnablerId,
fromOublietteId,
or toOublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.