OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.PathSpatialDesignSession
Implementsosid.OsidSession
Description

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.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupPaths
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedMapView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodanchorPathToCoordinate
Description

Anchors a path to a coordinate.

Parametersosid.id.IdpathIda path Id
osid.mapping.Coordinatecoordinatea coordinate
ErrorsNOT_FOUNDno Path found
NULL_ARGUMENT pathId or coordinate is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED coordinate not supported
CompliancemandatoryThis method must be implemented.
MethodclearCoordinatesFromPath
Description

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

Parametersosid.id.IdpathIda path Id
osid.mapping.Coordinatecoordinatea coordinate
ErrorsNOT_FOUNDno Path found
NULL_ARGUMENT pathId or coordinate is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED coordinate not supported
CompliancemandatoryThis method must be implemented.
MethodgetPathCoordinates
Description

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

Parametersosid.id.IdpathIda path Id
osid.mapping.Coordinatefroma coordinate
osid.mapping.Coordinatetoa coordinate
Returnosid.mapping.CoordinateListthe returned Coordinates
ErrorsNOT_FOUNDno Path found
NULL_ARGUMENT pathId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED from or to not supported
CompliancemandatoryThis method must be implemented.
MethodsetPathWidth
Description

Sets the width of the path between two coordinates.

Parametersosid.id.IdpathIda path Id
osid.mapping.Distancewidtha width
osid.mapping.Coordinatefroma coordinate
osid.mapping.Coordinatetoa coordinate
ErrorsNOT_FOUNDno Path found
NULL_ARGUMENT pathId, width, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED from or to not supported
CompliancemandatoryThis method must be implemented.
MethodassignSpatialUnitToPath
Description

Assigns a spatial unit to a path.

Parametersosid.id.IdpathIda path Id
osid.mapping.SpatialUnitspatialUnita spatial unit
ErrorsNOT_FOUNDno Path found
NULL_ARGUMENT pathId or spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDspatial unit not supported
CompliancemandatoryThis method must be implemented.
MethodclearSpatialUnitsFromPath
Description

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

Parametersosid.id.IdpathIda path Id
osid.mapping.SpatialUnitspatialUnita spatial unit
ErrorsNOT_FOUNDno Path found
NULL_ARGUMENT pathId or spatialUnit is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDspatial unit not supported
CompliancemandatoryThis method must be implemented.