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

Interface	osid.mapping.route.ResourceRouteAssignmentSession
Implements	`osid.OsidSession`
Description	This session defines methods to manage 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	canAssignResourceRoutes
Description	Tests if this user can set the routes for 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 assignment operations to unauthorized users.
Return	`boolean`		`false` if routing methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignResourceToRoute
Description	Assigns a resource to a route.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`routeId`	a route `Id`
Errors	ALREADY_EXISTS		`resourceId` already on `routeId`
	NOT_FOUND		`resourceId` or `routeId` is not found
	NULL_ARGUMENT		`resourceId` or `routeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRouteSegmentForResource
Description	Updates the route segment for a resource.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`routeSegmentId`	a route segment `Id`
Errors	NOT_FOUND		`resourceId` is not found
	NULL_ARGUMENT		`resourceId` or `routeSegmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		coordinate not supported
Compliance	`mandatory`		This method must be implemented.
Method	removeResourceFromRoute
Description	Unassigns a resource from a route.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`routeId`	a route `Id`
Errors	NOT_FOUND		`resourceId` or `routeId` is not found
	NULL_ARGUMENT		`resourceId` or `routeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.