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

Interface	osid.rules.check.AgendaSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session provides methods to process `Agendas`. `Agendas` are `OsidRules` that may require additional input in the form of an `AgendaCondition` to be evaluated. An `AgendaCondition` is acquired using `getAgendaCondition()`. The `AgendaConditionRecords` in the `AgendaCondition` must be supplied for a successful evaluation. Knowledge of a specific agenda `Id` is also an agreement to the understanding of the required `AgendaConditionRecords` as well as what is expected as a result. These record `Types` may be inspected in the `AgendaConditionRecord` and `CheckResultRecord` respectively.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the engine
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canEvaluateAgendas
Description	Tests if this user can evaluate agendas. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if agenda evaluation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgendaCondition
Description	Gets an `AgendaCondition` for the given `Agenda`. The record `Types` in the `AgendaCondition` are required for a successful evaluation.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of an `Agenda`
Return	`osid.rules.check.AgendaCondition`		an agenda condition
Errors	NOT_FOUND		`agendaId` is not found
	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure making request
Compliance	`mandatory`		This method must be implemented.
Method	evaluateAgendaOnCondition
Description	Evaluates an agenda based on an input condition. The status of each `Check` evaluation is returned in a `CheckResult`.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of an `Agenda`
Parameters	`osid.rules.Condition`	`agendaCondition`	an agenda condition
Return	`boolean`		`true` if the evaluation is successful, `false` if not successful
Errors	NOT_FOUND		`agendaId` is not found
	NULL_ARGUMENT		`agendaId` or `agendaCondition` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agendaCondition` did not otiginate from `getAgendaCondition()` or is missing information required to evaluate `agendaId`
Compliance	`mandatory`		This method must be implemented.