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