OSID - osid.mapping.path.rules.ObstacleEnablerMapAssignmentSession Service Interface Definition

Interface	osid.mapping.path.rules.ObstacleEnablerMapAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session provides methods to re-assign `ObstacleEnabler` to `Map` mappings. An `ObstacleEnabler` may appear in multiple `Map` objects and removing the last reference to an `ObstacleEnabler` 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 `ObstacleEnabler` to another `Map` is not a copy operation (eg: does not change its `Id`).
Method	canAssignObstacleEnablers
Description	Tests if this user can alter obstacle enabler/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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignObstacleEnablersToMap
Description	Tests if this user can alter obstacle enabler/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 lookup 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 enabler 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	getAssignableMapIdsForObstacleEnabler
Description	Gets a list of maps including and under the given map node in which a specific obstacle enabler can be assigned.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
Return	`osid.id.IdList`		list of assignable map `Ids`
Errors	NULL_ARGUMENT		`mapId` or `obstacleEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignObstacleEnablerToMap
Description	Adds an existing `ObstacleEnabler` to an `Map`.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	ALREADY_EXISTS		`obstacleEnablerId` is already assigned to `mapId`
	NOT_FOUND		`obstacleEnablerId` or `mapId` not found
	NULL_ARGUMENT		`obstacleEnablerId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignObstacleEnablerFromMap
Description	Removes an `ObstacleEnabler` from an `Map`.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Errors	NOT_FOUND		`obstacleEnablerId` or `mapId` not found or `obstacleEnablerId` not assigned to `mapId`
	NULL_ARGUMENT		`obstacleEnablerId` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignObstacleEnablerToMap
Description	Moves an `ObstacleEnabler` from one `Map` to another. Mappings to other `Maps` are unaffected.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
	`osid.id.Id`	`fromMapId`	the `Id` of the current `Map`
	`osid.id.Id`	`toMapId`	the `Id` of the destination `Map`
Errors	ALREADY_EXISTS		`obstacleEnablerId` already assigned to `toMapId`
	NOT_FOUND		`obstacleEnablerId, fromMapId`, or `toMapId` not found or `obstacleEnablerId` not mapped to `fromMapId`
	NULL_ARGUMENT		`obstacleEnablerId, fromMapId`, or `toMapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.