OSID - osid.rules.check.CheckEngineAssignmentSession Service Interface Definition

Interface	osid.rules.check.CheckEngineAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods to re-assign `Checks` to `Engine` mappings. A `Check` may appear in multiple `Engine` objects and removing the last reference to a `Check` is the equivalent of deleting it. Each `Engine` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Check` to another `Engine` is not a copy operation (eg: does not change its `Id`).
Method	canAssignChecks
Description	Tests if this user can alter hold/engine mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known check 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	canAssignChecksToEngine
Description	Tests if this user can alter hold/engine mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known check 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`	`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 check can be assigned.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Return	`osid.id.IdList`		list of assignable engine `Ids`
Errors	NULL_ARGUMENT		`engineId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableEngineIdsForCheck
Description	Gets a list of engines including and under the given engine node in which a specific check can be assigned.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check`
Return	`osid.id.IdList`		list of assignable engine `Ids`
Errors	NULL_ARGUMENT		`engineId` or `checkId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignCheckToEngine
Description	Adds an existing `Check` to a `Engine`.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Errors	ALREADY_EXISTS		`checkId` is already assigned to `engineId`
	NOT_FOUND		`checkId` or `engineId` not found
	NULL_ARGUMENT		`checkId` or `engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCheckFromEngine
Description	Removes a `Check` from a `Engine`.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Errors	NOT_FOUND		`checkId` or `engineId` not found or `checkId` not assigned to `engineId`
	NULL_ARGUMENT		`checkId` or `engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignCheckToEngine
Description	Moves a `Check` from one `Engine` to another. Mappings to other `Engines` are unaffected.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check`
	`osid.id.Id`	`fromEngineId`	the `Id` of the current `Engine`
	`osid.id.Id`	`toEngineId`	the `Id` of the destination `Engine`
Errors	ALREADY_EXISTS		`checkId` already assigned to `toEngineId`
	NOT_FOUND		`checkId, fromEngineId`, or `toEngineId` not found or `checkId` not mapped to `fromEngineId`
	NULL_ARGUMENT		`checkId, fromEngineId`, or `toEngineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.