public interface ObstacleEnablerMapAssignmentSession extends OsidSession
This session provides methods to re-assign ObstacleEnabler
to Map
mappings. An ObstacleEnabler
may appear in multiple Map
objects and removing the last
reference to an ObstacleEnabler
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 ObstacleEnabler
to another
Map
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignObstacleEnablerToMap(Id obstacleEnablerId,
Id mapId)
Adds an existing
ObstacleEnabler to an Map. |
boolean |
canAssignObstacleEnablers()
Tests if this user can alter obstacle enabler/map mappings.
|
boolean |
canAssignObstacleEnablersToMap(Id mapId)
Tests if this user can alter obstacle enabler/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of maps including and under the given map node in which
any obstacle enabler can be assigned.
|
IdList |
getAssignableMapIdsForObstacleEnabler(Id mapId,
Id obstacleEnablerId)
Gets a list of maps including and under the given map node in which a
specific obstacle enabler can be assigned.
|
void |
unassignObstacleEnablerFromMap(Id obstacleEnablerId,
Id mapId)
Removes an
ObstacleEnabler from an Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignObstacleEnablers()
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 canAssignObstacleEnablersToMap(Id mapId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup 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 getAssignableMapIdsForObstacleEnabler(Id mapId, Id obstacleEnablerId) throws OperationFailedException
mapId
- the Id
of the Map
obstacleEnablerId
- the Id
of the
ObstacleEnabler
Ids
NullArgumentException
- mapId
or
obstacleEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignObstacleEnablerToMap(Id obstacleEnablerId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler
to an Map.
obstacleEnablerId
- the Id
of the
ObstacleEnabler
mapId
- the Id
of the Map
AlreadyExistsException
- obstacleEnablerId
is already assigned to mapId
NotFoundException
- obstacleEnablerId
or
mapId
not foundNullArgumentException
- obstacleEnablerId
or mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignObstacleEnablerFromMap(Id obstacleEnablerId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler
from an Map.
obstacleEnablerId
- the Id
of the
ObstacleEnabler
mapId
- the Id
of the Map
NotFoundException
- obstacleEnablerId
or
mapId
not found or obstacleEnablerId
not assigned to mapId
NullArgumentException
- obstacleEnablerId
or mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.