public interface PathSpatialDesignSession extends OsidSession
This session defines methods for designing paths.
This lookup session defines several views:
Paths
with the PathAdminSession.
The methods useFederatedMapView()
and
useIsolatedMapView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
void |
anchorPathToCoordinate(Id pathId,
Coordinate coordinate)
Anchors a path to a coordinate.
|
void |
assignSpatialUnitToPath(Id pathId,
SpatialUnit spatialUnit)
Assigns a spatial unit to a path.
|
boolean |
canLookupPaths()
Tests if this user can perform
Path lookups. |
void |
clearCoordinatesFromPath(Id pathId,
Coordinate coordinate)
Clears the fixed coordinates from a path within the given coordinate.
|
void |
clearSpatialUnitsFromPath(Id pathId,
SpatialUnit spatialUnit)
Clears all spatial units within the given spatial unit from a path.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
CoordinateList |
getPathCoordinates(Id pathId,
Coordinate from,
Coordinate to)
Gets a list of fixed path coordinates between the given coordinates
along a path inclusive.
|
void |
setPathWidth(Id pathId,
Distance width,
Coordinate from,
Coordinate to)
Sets the width of the path between two coordinates.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupPaths()
Path
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. void anchorPathToCoordinate(Id pathId, Coordinate coordinate) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
coordinate
- a coordinateNotFoundException
- no Path
foundNullArgumentException
- pathId
or
coordinate
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- coordinate
not
supportedmandatory
- This method must be implemented. void clearCoordinatesFromPath(Id pathId, Coordinate coordinate) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
coordinate
- a coordinateNotFoundException
- no Path
foundNullArgumentException
- pathId
or
coordinate
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- coordinate
not
supportedmandatory
- This method must be implemented. CoordinateList getPathCoordinates(Id pathId, Coordinate from, Coordinate to) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
from
- a coordinateto
- a coordinate Coordinates
NotFoundException
- no Path
foundNullArgumentException
- pathId, from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- from
or to
not supportedmandatory
- This method must be implemented. void setPathWidth(Id pathId, Distance width, Coordinate from, Coordinate to) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
width
- a widthfrom
- a coordinateto
- a coordinateNotFoundException
- no Path
foundNullArgumentException
- pathId, width, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- from
or to
not supportedmandatory
- This method must be implemented. void assignSpatialUnitToPath(Id pathId, SpatialUnit spatialUnit) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
spatialUnit
- a spatial unitNotFoundException
- no Path
foundNullArgumentException
- pathId
or
spatialUnit
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- spatial unit not supportedmandatory
- This method must be implemented. void clearSpatialUnitsFromPath(Id pathId, SpatialUnit spatialUnit) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathId
- a path Id
spatialUnit
- a spatial unitNotFoundException
- no Path
foundNullArgumentException
- pathId
or
spatialUnit
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- spatial unit not supportedmandatory
- This method must be implemented.