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

Interface	osid.mapping.path.rules.ObstacleEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `ObstacleEnablers` to `Obstacles.` An `Obstacle` with multiple `ObstacleEnablers` means any positive rule evaluation across the enablers result in an enabled `Obstacle.`
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	canAssignObstacleEnablers
Description	Tests if this user can alter obstacle enabler/obstacle 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	assignObstacleEnablerToObstacle
Description	Adds an existing `ObstacleEnabler` to an `Obstacle.`
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle`
Errors	ALREADY_EXISTS		`obstacleEnablerId` is already applied to `obstacleId`
	NOT_FOUND		`obstacleEnablerId` or `obstacleId` not found
	NULL_ARGUMENT		`obstacleEnablerId` or `obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignObstacleEnablerFromObstacle
Description	Removes an `ObstacleEnabler` from an `Obstacle.`
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle`
Errors	NOT_FOUND		`obstacleEnablerId` or `obstacleId` not found or `obstacleEnablerId` not applied to `obstacleId`
	NULL_ARGUMENT		`obstacleEnablerId` or `obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceObstacleEnablers
Description	Tests if this user can order `ObstacleEnablers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `ObstacleEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveObstacleEnablerAhead
Description	Reorders obstacle enablers for an obstacle by moving the specified obstacle enabler in front of a reference obstacle enabler.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of an `ObstacleEnabler`
	`osid.id.Id`	`obstacleId`	the `Id` of an `Obstacle`
	`osid.id.Id`	`referenceId`	the reference obstacle enabler `Id`
Errors	NOT_FOUND		`obstacleEnablerId, obstacleId,` or `referenceId` not found or, `obstacleEnablerId` or `referenceId` not related to `obstacleId`
	NULL_ARGUMENT		`obstacleEnablerId, obstacleId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveObstacleEnablerBehind
Description	Reorders obstacle enablers for an obstacle by moving the specified obstacle enabler behind a reference obstacle enabler.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of an `ObstacleEnabler`
	`osid.id.Id`	`obstacleId`	the `Id` of an `Obstacle`
	`osid.id.Id`	`referenceId`	the reference obstacle enabler `Id`
Errors	NOT_FOUND		`obstacleEnablerId, obstacleId,` or `referenceId` not found or, `obstacleEnablerId` or `referenceId` not related to `obstacleId`
	NULL_ARGUMENT		`obstacleEnablerId, obstacleId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderObstacleEnablers
Description	Reorders a set of obstacle enablers for an obstacle.
Parameters	`osid.id.Id[]`	`obstacleEnablerIds`	the `Ids` for a set of `ObstacleEnablers`
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of an `Obstacle`
Errors	NOT_FOUND		`obstacleId` not found or, an `obstacleEnablerId` not related to `obstacleId`
	NULL_ARGUMENT		`obstacleEnabelrIds` or `obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.