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

Interface	osid.mapping.path.PathTravelSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods for examining `Path` travel. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete 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 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. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. 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	canLookupPathTravel
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 opt not to 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 lookups to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	getObstacles
Description	Gets an `ObstacleList` corresponding to the given `Path` and coordinate range. In plenary mode, the returned list contains all of the obstacles as defined. Otherwise, inaccessible `Obstacles` may be omitted from the list or overlapping obstacles may be reordered.
Parameters	`osid.id.Id`	`pathId`	`Id` of the `Path`
	`osid.mapping.Coordinate`	`coordinate`	starting coordinate
	`osid.mapping.Distance`	`distance`	a distance from coordinate
Return	`osid.mapping.path.ObstacleList`		the obstacle list
Errors	INVALID_ARGUMENT		coordinate not on path
	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId, coordinate` or `distance` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getAverageSpeed
Description	Gets the expected average speed for a traveler along a path between the given coordinates. If the path is blocked by an obstacle, then the speed is zero. Some obstacles may have the effect of lowering the expected speed.
Parameters	`osid.id.Id`	`pathId`	`Id` of the `Path`
	`osid.mapping.Coordinate`	`coordinate`	starting coordinate
	`osid.mapping.Distance`	`distance`	a distance from coordinate
Return	`osid.mapping.Speed`		the speed
Errors	INVALID_ARGUMENT		coordinate not on path
	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId, coordinate` or `distance` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getSpeedZones
Description	Gets a `SpeedZoneList` corresponding to the given `Path` and coordinate range. In plenary mode, the returned list contains all of the speed zones as defined. Otherwise, inaccessible `SpeedZones` may be omitted from the list or overlapping speed zones may be reordered.
Parameters	`osid.id.Id`	`pathId`	`Id` of the `Path`
	`osid.mapping.Coordinate`	`coordinate`	starting coordinate
	`osid.mapping.Distance`	`distance`	a distance from coordinate
Return	`osid.mapping.path.SpeedZoneList`		the list of speed zones
Errors	INVALID_ARGUMENT		coordinate not on path
	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId, coordinate or distance is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getSpeedZonesAtResolution
Description	Gets a `SpeedZoneList` corresponding to the given `Path` and coordinate range for a given resolution.
Parameters	`osid.id.Id`	`pathId`	`Id` of the `Path`
	`osid.mapping.Coordinate`	`coordinate`	starting coordinate
	`osid.mapping.Distance`	`distance`	a distance from coordinate
	`osid.mapping.Distance`	`resolution`	the resolution
Return	`osid.mapping.path.SpeedZoneList`		the list of speed zones
Errors	INVALID_ARGUMENT		coordinate not on path
	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId, coordinate, distance` or `resolution` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.