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

Interface	osid.rules.check.AgendaEngineAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods to re-assign `Agendas` to `Engine` mappings. An `Agenda` may appear in multiple `Engine` objects and removing the last reference to an `Agenda` 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 an `Agenda` to another `Engine` is not a copy operation (eg: does not change its `Id`).
Method	canAssignAgendas
Description	Tests if this user can alter agenda/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 lookup operations to unauthorized users.
Return	`boolean`		`false` if check is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignAgendasToEngine
Description	Tests if this user can alter agenda/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 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 agenda 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	getAssignableEngineIdsForAgenda
Description	Gets a list of engines including and under the given engine node in which a specific agenda can be assigned.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda`
Return	`osid.id.IdList`		list of assignable engine `Ids`
Errors	NULL_ARGUMENT		`engineId` or `agendaId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignAgendaToEngine
Description	Adds an existing `Agenda` to a `Engine`.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Errors	ALREADY_EXISTS		`agendaId` is already assigned to `engineId`
	NOT_FOUND		`agendaId` or `engineId` not found
	NULL_ARGUMENT		`agendaId` or `engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAgendaFromEngine
Description	Removes an `Agenda` from a `Engine`.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Errors	NOT_FOUND		`agendaId` or `engineId` not found or `agendaId` not assigned to `engineId`
	NULL_ARGUMENT		`agendaId` or `engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignAgendaToEngine
Description	Moves an `Agenda` from one `Engine` to another. Mappings to other `Engines` are unaffected.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda`
	`osid.id.Id`	`fromEngineId`	the `Id` of the current `Engine`
	`osid.id.Id`	`toEngineId`	the `Id` of the destination `Engine`
Errors	ALREADY_EXISTS		`agendaId` already assigned to `toEngineId`
	NOT_FOUND		`agendaId, fromEngineId`, or `toEngineId` not found or `agendaId` not mapped to `fromEngineId`
	NULL_ARGUMENT		`agendaId, fromEngineId`, or `toEngineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.