public interface SpeedZoneEnablerMapAssignmentSession extends OsidSession
This session provides methods to re-assign SpeedZoneEnabler
to Map
mappings. a SpeedZoneEnabler
may appear in multiple Map
objects and removing the last
reference to a SpeedZoneEnabler
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 SpeedZoneEnabler
to another
Map
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSpeedZoneEnablerToMap(Id speedZoneEnablerId,
Id mapId)
Adds an existing
SpeedZoneEnabler to an Map. |
boolean |
canAssignSpeedZoneEnablers()
Tests if this user can alter speed zone enabler/map mappings.
|
boolean |
canAssignSpeedZoneEnablersToMap(Id mapId)
Tests if this user can alter speed zone enabler/map mappings.
|
IdList |
getAssignableMapIds(Id mapId)
Gets a list of map including and under the given map node in which any
speed zone enabler can be assigned.
|
IdList |
getAssignableMapIdsForSpeedZoneEnabler(Id mapId,
Id speedZoneEnablerId)
Gets a list of map including and under the given map node in which a
specific speed zone enabler can be assigned.
|
void |
unassignSpeedZoneEnablerFromMap(Id speedZoneEnablerId,
Id mapId)
Removes a
SpeedZoneEnabler from an Map. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignSpeedZoneEnablers()
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 canAssignSpeedZoneEnablersToMap(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 getAssignableMapIdsForSpeedZoneEnabler(Id mapId, Id speedZoneEnablerId) throws OperationFailedException
mapId
- the Id
of the Map
speedZoneEnablerId
- the Id
of the
SpeedZoneEnabler
Ids
NullArgumentException
- mapId
or
speedZoneEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSpeedZoneEnablerToMap(Id speedZoneEnablerId, Id mapId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneEnabler
to an Map.
speedZoneEnablerId
- the Id
of the
SpeedZoneEnabler
mapId
- the Id
of the Map
AlreadyExistsException
- speedZoneEnablerId
is already assigned to mapId
NotFoundException
- speedZoneEnablerId
or mapId
not foundNullArgumentException
- speedZoneEnablerId
or mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSpeedZoneEnablerFromMap(Id speedZoneEnablerId, Id mapId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SpeedZoneEnabler
from an Map.
speedZoneEnablerId
- the Id
of the
SpeedZoneEnabler
mapId
- the Id
of the Map
NotFoundException
- speedZoneEnablerId
or mapId
not found or speedZoneEnablerId
not assigned to mapId
NullArgumentException
- speedZoneEnablerId
or mapId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.