OSID - osid.mapping.path.PathSpatialSession Service Interface Definition

Interface	osid.mapping.path.PathSpatialSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session defines methods for retrieving paths through spatial queries. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated map view: All path methods in this session operate, retrieve and pertain to paths defined explicitly in the current map. 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	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPaths
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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePathView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryPathView
Description	A complete view of the `Path` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is 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	getPathsAtCoordinate
Description	Gets the paths at the given coordinate. In plenary mode, all paths are returned or an error results. In comparative mode, the returned list may omit inaccessible paths or reorder them.
Parameters	`osid.mapping.Coordinate`	`coordinate`	a coordinate
Return	`osid.mapping.path.PathList`		the returned `PathList`
Errors	NULL_ARGUMENT		`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	getPathsAtCoordinates
Description	Gets the paths at the given coordinate list. In plenary mode, all paths are returned for each supplied coordinate or an error results. In comparative mode, the returned list may omit inaccessible paths or reorder them.
Parameters	`osid.mapping.CoordinateList`	`coordinates`	a coordinate list
Return	`osid.mapping.path.PathList`		the returned `Paths`
Errors	NULL_ARGUMENT		`coordinates` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		a coordinate is not supported
Compliance	`mandatory`		This method must be implemented.
Method	getPathsInSpatialUnit
Description	Gets the paths that are included inside the given spatial unit. In plenary mode, all paths are returned or an error results.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	a spatial unit
Return	`osid.mapping.path.PathList`		the returned `Paths`
Errors	NULL_ARGUMENT		`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	getPathsOverlappingSpatialUnit
Description	Gets the paths that are included inside or touch the given spatial unit. In plenary mode, all paths are returned or an error results.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	a spatial unit
Return	`osid.mapping.path.PathList`		the returned `Paths`
Errors	NULL_ARGUMENT		`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	getPathSpatialUnits
Description	Gets a list of spatial units 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.SpatialUnitList`		the returned `SpatialUnits`
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	getPathSpatialUnitsAtResolution
Description	Gets a list of spatial units at the given given distance from a coordinate along a path inclusive at the given resolution.
Parameters	`osid.id.Id`	`pathId`	a path `Id`
	`osid.mapping.Coordinate`	`coordinate`	a coordinate
	`osid.mapping.Distance`	`distance`	a distance
	`osid.mapping.Distance`	`resolution`	the resolution
Return	`osid.mapping.SpatialUnitList`		the returned `SpatialUnits`
Errors	NOT_FOUND		no `Path` found
	NULL_ARGUMENT		`pathId, coordinate, distance` or `resolution` 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.