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

Interface	osid.mapping.route.RouteMapAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.route.MappingRouteManager`
Used By	`osid.mapping.route.MappingRouteProxyManager`
Description	This session provides methods to re-assign `Routes` to `Maps`. A `Route` may appear in multiple `Maps` and removing the last reference to a `Route` is the equivalent of deleting it. Each `Map` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Route` to another `Map` is not a copy operation (eg: does not change its `Id`).
Method	canAssignRoutes
Description	Tests if this user can alter route/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location 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 assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignRoutesToMap
Description	Tests if this user can alter route/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location 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 assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`mapId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableMapIds
Description	Gets a list of maps including and under the given map node in which any route can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableMapIdsForRoute
Description	Gets a list of maps including and under the given map node in which a specific route can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Parameters	`osid.id.Id`	`routeId`	the `Id` of the `Route`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` or `routeId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignRouteToMap
Description	Adds an existing `Route` to a `Map`.
Parameters	`osid.id.Id`	`routeId`	the `Id` of the `Route`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	ALREADY_EXISTS		`routeId` is already assigned to `mapId`
	NOT_FOUND		`routeId` or `mapId` not found
	NULL_ARGUMENT		`routeId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRouteFromMap
Description	Removes a `Route` from a `Map`.
Parameters	`osid.id.Id`	`routeId`	the `Id` of the `Route`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	NOT_FOUND		`routeId` or `mapId` not found or `routeId` not assigned to `mapId`
	NULL_ARGUMENT		`routeId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCreditToMap
Description	Moves a `Route` from one `Map` to another. Mappings to other `Maps` are unaffected.
Parameters	`osid.id.Id`	`routeId`	the `Id` of the `Route`
	`osid.id.Id`	`fromMapId`	the `Id` of the current `Map`
	`osid.id.Id`	`toMapId`	the `Id` of the destination `Map`
Errors	ALREADY_EXISTS		`routeId` already assigned to `toMapId`
	NOT_FOUND		`routeId fromMapId`, or `toMapId` not found or `routeId` not mapped to `fromMapId`
	NULL_ARGUMENT		`routeId, fromMapId`, or `toMapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.