Interface PathSpatialDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PathSpatialDesignSession
extends OsidSession

This session defines methods for designing paths.

This lookup session defines several views:

• isolated map view: All path methods in this session operate, retrieve and pertain to paths defined explicitly in the current map. Using an isolated view is useful for managing Paths with the PathAdminSession .
• federated map view: All path lookup methods in this session operate, retrieve and pertain to all paths defined in this map and any other paths implicitly available in this map through map inheritence.

The methods useFederatedMapView() and useIsolatedMapView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
    throws OperationFailedException,
PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupPaths

boolean canLookupPaths()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedMapView

void useFederatedMapView()

Federates the view for methods in this session. A federated view will include paths in maps which are children of this map in the map hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedMapView

void useIsolatedMapView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this map only.

Compliance:

mandatory - This method is must be implemented.

anchorPathToCoordinate

void anchorPathToCoordinate(Id pathId,
 Coordinate coordinate)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Anchors a path to a coordinate.

Parameters:

pathId - a path Id

coordinate - a coordinate

Throws:

NotFoundException - no Path found

NullArgumentException - pathId or coordinate is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - coordinate not supported

Compliance:

mandatory - This method must be implemented.

clearCoordinatesFromPath

void clearCoordinatesFromPath(Id pathId,
 Coordinate coordinate)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears the fixed coordinates from a path within the given coordinate.

Parameters:

pathId - a path Id

coordinate - a coordinate

Throws:

NotFoundException - no Path found

NullArgumentException - pathId or coordinate is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - coordinate not supported

Compliance:

mandatory - This method must be implemented.

getPathCoordinates

CoordinateList getPathCoordinates(Id pathId,
 Coordinate from,
 Coordinate to)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of fixed path coordinates between the given coordinates along a path inclusive.

Parameters:

pathId - a path Id

from - a coordinate

to - a coordinate

Returns:

the returned Coordinates

Throws:

NotFoundException - no Path found

NullArgumentException - pathId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - from or to not supported

Compliance:

mandatory - This method must be implemented.

setPathWidth

void setPathWidth(Id pathId,
 Distance width,
 Coordinate from,
 Coordinate to)
           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Sets the width of the path between two coordinates.

Parameters:

pathId - a path Id

width - a width

from - a coordinate

to - a coordinate

Throws:

NotFoundException - no Path found

NullArgumentException - pathId, width, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - from or to not supported

Compliance:

mandatory - This method must be implemented.

assignSpatialUnitToPath

void assignSpatialUnitToPath(Id pathId,
 SpatialUnit spatialUnit)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Assigns a spatial unit to a path.

Parameters:

pathId - a path Id

spatialUnit - a spatial unit

Throws:

NotFoundException - no Path found

NullArgumentException - pathId or spatialUnit is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - spatial unit not supported

Compliance:

mandatory - This method must be implemented.

clearSpatialUnitsFromPath

void clearSpatialUnitsFromPath(Id pathId,
 SpatialUnit spatialUnit)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears all spatial units within the given spatial unit from a path.

Parameters:

pathId - a path Id

spatialUnit - a spatial unit

Throws:

NotFoundException - no Path found

NullArgumentException - pathId or spatialUnit is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - spatial unit not supported

Compliance:

mandatory - This method must be implemented.