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