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

Interface	osid.rules.check.InstructionNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.rules.check.RulesCheckManager`
Used By	`osid.rules.check.RulesCheckProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Instruction` objects in this `Engine`. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `InstructionLookupSession`.
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	canRegisterForInstructionNotifications
Description	Tests if this user can register for `Instruction` notifications. 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 opt not to offer notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedEngineView
Description	Federates the view for methods in this session. A federated view will include instructions in engines which are children of this engine in the engine hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedEngineView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this engine only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableInstructionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeInstructionNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableInstructionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeInstructionNotification
Description	Acknowledge an instruction notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewInstructions
Description	Register for notifications of new instructions. `InstructionReceiver.newInstructions()` is invoked when a new `Instruction` appears in this engine.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewInstructionsForAgenda
Description	Register for notifications of new instructions related to the given agenda. `InstructionReceiver.newInstructions()` is invoked when a new `Instruction` appears in this engine.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda` to monitor
Errors	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewInstructionsForCheck
Description	Register for notifications of new instructions related to the given agenda. `InstructionReceiver.newInstructions()` is invoked when a new `Instruction` appears in this engine.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check` to monitor
Errors	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInstructions
Description	Registers for notification of updated instructions. `InstructionReceiver.changedInstructions()` is invoked when an instruction in this engine is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInstructionsForAgenda
Description	Registers for notification of updated instructions related to the given agenda. `InstructionReceiver.changedInstructions()` is invoked when an instruction related to the agenda in this engine is changed.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda` to monitor
Errors	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInstructionsForCheck
Description	Registers for notification of updated instructions related to the given check. `InstructionReceiver.changedInstructions()` is invoked when an instruction related to the check in this engine is changed.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check` to monitor
Errors	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInstruction
Description	Registers for notification of an updated instruction. `InstructionReceiver.changedInstructions()` is invoked when the specified instruction in this engine is changed.
Parameters	`osid.id.Id`	`instructionId`	the `Id` of the `Instruction` to monitor
Errors	NOT_FOUND		an instruction was not found in this engine identified by the given `Id`
	NULL_ARGUMENT		`instructionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInstructions
Description	Registers for notification of deleted instructions. `InstructionReceiver.deletedInstructions()` is invoked when an instruction is deleted or removed from this engine.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInstructionsForAgenda
Description	Registers for notification of deleted instruction for an agenda. `InstructionReceiver.deletedInstructions()` is invoked when the related instruction is deleted or removed from this engine.
Parameters	`osid.id.Id`	`agendaId`	the `Id` of the `Agenda` to monitor
Errors	NULL_ARGUMENT		`agendaId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInstructionsForCheck
Description	Registers for notification of deleted instruction for a check. `InstructionReceiver.deletedInstructions()` is invoked when the related instruction is deleted or removed from this engine.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check` to monitor
Errors	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInstruction
Description	Registers for notification of a deleted instruction. `InstructionReceiver.deletedInstructions()` is invoked when the specified instruction is deleted or removed from this engine.
Parameters	`osid.id.Id`	`instructionId`	the `Id` of the `Instruction` to monitor
Errors	NOT_FOUND		an instruction was not found identified by the given `Id`
	NULL_ARGUMENT		`instructionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.