OSID - osid.mapping.route.ResourceRouteSession Service Interface Definition

Interface	osid.mapping.route.ResourceRouteSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.route.MappingRouteManager`
Used By	`osid.mapping.route.MappingRouteProxyManager`
Description	This session defines methods to track resources on routes.
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	canAccessResourceRoutes
Description	Tests if this user can access the locations of resources. 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 location operations to unauthorized users.
Return	`boolean`		`false` if location methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeResourceRouteView
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	usePlenaryResourceRouteView
Description	A complete view of the `Resource` 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	isResourceOnARoute
Description	Tests if the resource is traveling along a route.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`boolean`		`true` if the resource is on a route, `false` otherrwise
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentForResource
Description	Gets the current route of the given resource.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.mapping.route.RouteSegment`		the current route segment
Errors	ILLEGAL_STATE		`isResourceOnARoute()` is `false`
	NOT_FOUND		`resourceId` is not on map
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentsForResources
Description	Gets the current locations of the given resources. In plenary mode, the routes for all the given resources are returned or an error results. In comparative mode, routes may be omitted or reordered.
Parameters	`osid.id.IdList`	`resourceIds`	a resource list
Return	`osid.mapping.route.RouteSegmentList`		the current route segments
Errors	NOT_FOUND		a `resourceId` is not on map
	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesOnRoute
Description	Gets the resources along the given route. In plenary mode, all the resources on the route are returned or an error results. In comparative mode, resources may be omitted or reordered.
Parameters	`osid.id.Id`	`routeId`	a route `Id`
Return	`osid.resource.ResourceList`		the resources on the route
Errors	NULL_ARGUMENT		`routeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourcesOnRouteSegment
Description	Gets the resources on the given route segment. In plenary mode, all the resources on the route segment are returned or an error results. In comparative mode, resources may be omitted or reordered.
Parameters	`osid.id.Id`	`routeSegmentId`	a route segment `Id`
Return	`osid.resource.ResourceList`		the resources on the route segment
Errors	NULL_ARGUMENT		`routeSegmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRouteProgressForResource
Description	Gets the route progress for the given resource.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.mapping.route.RouteProgress`		the current route progress
Errors	ILLEGAL_STATE		`isResourceOnARoute()` is `false`
	NOT_FOUND		`resourceId` is not on map
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRouteProgressForResources
Description	Gets the route progress for the given resources. In plenary mode, the routes for all the given resources are returned or an error results. In comparative mode, routes may be omitted or reordered.
Parameters	`osid.id.IdList`	`resourceIds`	a resource list
Return	`osid.mapping.route.RouteProgressList`		the current route progress
Errors	NOT_FOUND		a `resourceId` is not found
	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.