public interface SpeedZoneMapAssignmentSession extends OsidSession
This session provides methods to re-assign SpeedZones
to
Map
objects A SpeedZone
may appear in
multiple Map
objects and removing the last reference to a
SpeedZone
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 a SpeedZone
to another Map
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSpeedZoneToMap(Id speedZoneId,
Id mapId)
Adds an existing
SpeedZone to a Map. |
boolean |
canAssignSpeedZones()
Tests if this user can alter speed zone/map mappings.
|
boolean |
canAssignSpeedZonesToMap(Id mapId)
Tests if this user can alter speed zone/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of maps including and under the given map node in which
any speed zone can be assigned.
|
IdList |
getAssignableMapIdsForSpeedZone(Id mapId,
Id speedZoneId)
Gets a list of maps including and under the given map node in which a
specific speed zone can be assigned.
|
void |
unassignSpeedZoneFromMap(Id speedZoneId,
Id mapId)
Removes a
SpeedZone from a Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignSpeedZones()
PERMISSION_DENIED.
This is intended as a
hint to an application that may opt not to offer assignment operations
to unauthorized users. false
if speed zone is not authorized,
true
otherwisemandatory
- This method must be implemented. boolean canAssignSpeedZonesToMap(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 getAssignableMapIdsForSpeedZone(Id mapId, Id speedZoneId) throws OperationFailedException
mapId
- the Id
of the Map
speedZoneId
- the Id
of the SpeedZone
Ids
NullArgumentException
- mapId
or
speedZoneId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSpeedZoneToMap(Id speedZoneId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZone
to a Map.
speedZoneId
- the Id
of the SpeedZone
mapId
- the Id
of the Map
AlreadyExistsException
- speedZoneId
is
already assigned to mapId
NotFoundException
- speedZoneId
or
mapId
not foundNullArgumentException
- speedZoneId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSpeedZoneFromMap(Id speedZoneId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZone
from a Map.
speedZoneId
- the Id
of the SpeedZone
mapId
- the Id
of the Map
NotFoundException
- speedZoneId
or
mapId
not found or speedZoneId
not assigned to mapId
NullArgumentException
- speedZoneId
or
mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.