public interface HoldOublietteAssignmentSession extends OsidSession
This session provides methods to re-assign Holds
to
Oubliette
mappings. A Hold
may appear in
multiple Oubliette
objects and removing the last reference
to a Hold
is the equivalent of deleting it. Each
Oubliette
may have its own authorizations governing who is allowed
to operate on it.
Adding a reference of a Hold
to another
Oubliette
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignHoldToOubliette(Id holdId,
Id oublietteId)
Adds an existing
Hold to a Oubliette. |
boolean |
canAssignHolds()
Tests if this user can alter hold/oubliette mappings.
|
boolean |
canAssignHoldsToOubliette(Id oublietteId)
Tests if this user can alter hold/oubliette mappings.
|
IdList |
getAssignableOublietteIds(Id oublietteId)
Gets a list of oubliettes including and under the given oubliette node
in which any hold can be assigned.
|
IdList |
getAssignableOublietteIdsForHold(Id oublietteId,
Id holdId)
Gets a list of oubliettes including and under the given oubliette node
in which a specific hold can be assigned.
|
void |
reassignHoldToOubliette(Id holdId,
Id fromOublietteId,
Id toOublietteId)
Moves a
Hold from one Oubliette to
another. |
void |
unassignHoldFromOubliette(Id holdId,
Id oublietteId)
Removes a
Hold from a Oubliette. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignHolds()
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 canAssignHoldsToOubliette(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 getAssignableOublietteIdsForHold(Id oublietteId, Id holdId) throws OperationFailedException
oublietteId
- the Id
of the Oubliette
holdId
- the Id
of the Hold
Ids
NullArgumentException
- oublietteId
or
holdId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignHoldToOubliette(Id holdId, Id oublietteId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Hold
to a Oubliette.
holdId
- the Id
of the Hold
oublietteId
- the Id
of the Oubliette
AlreadyExistsException
- holdId
is
already assigned to oublietteId
NotFoundException
- holdId
or
oublietteId
not foundNullArgumentException
- holdId
or
oublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignHoldFromOubliette(Id holdId, Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Hold
from a Oubliette.
holdId
- the Id
of the Hold
oublietteId
- the Id
of the Oubliette
NotFoundException
- holdId
or
oublietteId
not found or holdId
not
assigned to oublietteId
NullArgumentException
- holdId
or
oublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignHoldToOubliette(Id holdId, Id fromOublietteId, Id toOublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Hold
from one Oubliette
to
another. Mappings to other Oubliettes
are unaffected.holdId
- the Id
of the Hold
fromOublietteId
- the Id
of the current
Oubliette
toOublietteId
- the Id
of the destination
Oubliette
NotFoundException
- holdId, fromOublietteId,
or toOublietteId
not found or
holdId
not mapped to fromOublietteId
NullArgumentException
- holdId, fromOublietteId,
or toOublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.