public interface BlockOublietteAssignmentSession extends OsidSession
This session provides methods to re-assign Blocks
to
Oubliette
mappings. A Block
may appear in
multiple Oubliette
objects and removing the last reference
to a Block
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 Block
to another
Oubliette
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignBlockToOubliette(Id blockId,
Id oublietteId)
Adds an existing
Block to a Oubliette. |
boolean |
canAssignBlocks()
Tests if this user can alter block/oubliette mappings.
|
boolean |
canAssignBlocksToOubliette(Id oublietteId)
Tests if this user can alter block/oubliette mappings.
|
IdList |
getAssignableOublietteIds(Id oublietteId)
Gets a list of oubliettes including and under the given oubliette node
in which any block can be assigned.
|
IdList |
getAssignableOublietteIdsForBlock(Id oublietteId,
Id blockId)
Gets a list of oubliettes including and under the given oubliette node
in which a specific block can be assigned.
|
void |
reassignBlockToOubliette(Id blockId,
Id fromOublietteId,
Id toOublietteId)
Moves a
Block from one Oubliette to
another. |
void |
unassignBlockFromOubliette(Id blockId,
Id oublietteId)
Removes a
Block from a Oubliette. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignBlocks()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if hold is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignBlocksToOubliette(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 getAssignableOublietteIdsForBlock(Id oublietteId, Id blockId) throws OperationFailedException
oublietteId
- the Id
of the Oubliette
blockId
- the Id
of the Block
Ids
NullArgumentException
- oublietteId
or
blockId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignBlockToOubliette(Id blockId, Id oublietteId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Block
to a Oubliette.
blockId
- the Id
of the Block
oublietteId
- the Id
of the Oubliette
AlreadyExistsException
- blockId
is
already assigned to oublietteId
NotFoundException
- blockId
or
oublietteId
not foundNullArgumentException
- blockId
or
oublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignBlockFromOubliette(Id blockId, Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Block
from a Oubliette.
blockId
- the Id
of the Block
oublietteId
- the Id
of the Oubliette
NotFoundException
- blockId
or
oublietteId
not found or blockId
is not
assigned to oublietteId
NullArgumentException
- blockId
or
oublietteId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignBlockToOubliette(Id blockId, Id fromOublietteId, Id toOublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Block
from one Oubliette
to
another. Mappings to other Oubliettes
are unaffected.blockId
- the Id
of the Block
fromOublietteId
- the Id
of the current
Oubliette
toOublietteId
- the Id
of the destination
Oubliette
NotFoundException
- blockId, fromOublietteId,
or toOublietteId
not found or
blockId
not mapped to fromOublietteId
NullArgumentException
- blockId,
fromOublietteId,
or toOublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.