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

Interface	osid.mapping.path.ObstacleMapAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session provides methods to re-assign `Obstacles` to `Map` objects An `Obstacle` may appear in multiple `Map` objects and removing the last reference to an `Obstacle` 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 an `Obstacle` to another `Map` is not a copy operation (eg: does not change its `Id`).
Method	canAssignObstacles
Description	Tests if this user can alter obstacle/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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	canAssignObstaclesToMap
Description	Tests if this user can alter obstacle/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 obstacle 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	getAssignableMapIdsForObstacle
Description	Gets a list of maps including and under the given map node in which a specific obstacle can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` or `obstacleId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignObstacleToMap
Description	Adds an existing `Obstacle` to a `Map`.
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	ALREADY_EXISTS		`obstacleId` is already assigned to `mapId`
	NOT_FOUND		`obstacleId` or `mapId` not found
	NULL_ARGUMENT		`obstacleId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignObstacleFromMap
Description	Removes an `Obstacle` from a `Map`.
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	NOT_FOUND		`obstacleId` or `mapId` not found or `obstacleId` not assigned to `mapId`
	NULL_ARGUMENT		`obstacleId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.