Interface | osid.mapping.path.PathSpatialDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for designing paths. This lookup session defines several views:
The methods | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupPaths | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedMapView | ||
Description |
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. | |
Method | useIsolatedMapView | ||
Description |
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. | |
Method | anchorPathToCoordinate | ||
Description |
Anchors a path to a coordinate. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Coordinate | coordinate | a coordinate | |
Errors | NOT_FOUND | no Path found | |
NULL_ARGUMENT | pathId or coordinate is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | coordinate not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCoordinatesFromPath | ||
Description |
Clears the fixed coordinates from a path within the given coordinate. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Coordinate | coordinate | a coordinate | |
Errors | NOT_FOUND | no Path found | |
NULL_ARGUMENT | pathId or coordinate is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | coordinate not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathCoordinates | ||
Description |
Gets a list of fixed path coordinates between the given coordinates along a path inclusive. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Coordinate | from | a coordinate | |
osid.mapping.Coordinate | to | a coordinate | |
Return | osid.mapping.CoordinateList | the returned Coordinates | |
Errors | NOT_FOUND | no Path found | |
NULL_ARGUMENT | pathId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | from or to not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | setPathWidth | ||
Description |
Sets the width of the path between two coordinates. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Distance | width | a width | |
osid.mapping.Coordinate | from | a coordinate | |
osid.mapping.Coordinate | to | a coordinate | |
Errors | NOT_FOUND | no Path found | |
NULL_ARGUMENT | pathId, width, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | from or to not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignSpatialUnitToPath | ||
Description |
Assigns a spatial unit to a path. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.SpatialUnit | spatialUnit | a spatial unit | |
Errors | NOT_FOUND | no Path found | |
NULL_ARGUMENT | pathId or spatialUnit is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | spatial unit not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSpatialUnitsFromPath | ||
Description |
Clears all spatial units within the given spatial unit from a path. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.SpatialUnit | spatialUnit | a spatial unit | |
Errors | NOT_FOUND | no Path found | |
NULL_ARGUMENT | pathId or spatialUnit is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | spatial unit not supported | ||
Compliance | mandatory | This method must be implemented. |