OSID - osid.rules.RuleEngineAssignmentSession Service Interface Definition

Interface	osid.rules.RuleEngineAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.rules.RulesManager`
Used By	`osid.rules.RulesProxyManager`
Description	This session provides methods to re-assign `TerRulesms` to `Engines` .A `Rule` may appear in multiple `Engines` and removing the last reference to a `Rule` is the equivalent of deleting it. Each `Rule` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Rule` to another `Engine` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignRules
Description	Tests if this user can alter rule/engine 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	canAssignRulesToEngine
Description	Tests if this user can alter rule/engine 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`	`engineId`	the `Id` of the `Engine`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`engineId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableEngineIds
Description	Gets a list of engines including and under the given engine node in which any rule can be assigned.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Return	`osid.id.IdList`		list of assignable rule `Ids`
Errors	NULL_ARGUMENT		`engineId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableEngineIdsForRule
Description	Gets a list of engines including and under the given engine node in which a specific rule can be assigned.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Engine`
Return	`osid.id.IdList`		list of assignable engine `Ids`
Errors	NULL_ARGUMENT		`engineId` or `ruleId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignRuleToEngine
Description	Adds an existing `Rule` to an `Engine` .
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Errors	ALREADY_EXISTS		`ruleId` is already assigned to `engineId`
	NOT_FOUND		`ruleId` or `engineId` not found
	NULL_ARGUMENT		`ruleId` or `engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRuleFromEngine
Description	Removes a `Rule` from an `Engine` .
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Errors	NOT_FOUND		`ruleId` or `engineId` not found or `ruleId` not assigned to `engineId`
	NULL_ARGUMENT		`ruleId` or `engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignRuleToEngine
Description	Moves a `Rule` from one `Engine` to another. Mappings to other `Engines` are unaffected.
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule`
	`osid.id.Id`	`fromEngineId`	the `Id` of the current `Engine`
	`osid.id.Id`	`toEngineId`	the `Id` of the destination `Engine`
Errors	ALREADY_EXISTS		`ruleId` already assigned to `toEngineId`
	NOT_FOUND		`ruleId, fromEngineId` , or `toEngineId` not found or `ruleId` not mapped to `fromEngineId`
	NULL_ARGUMENT		`ruleId, fromEngineId` , or `toEngineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.