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

Interface	osid.rules.check.CheckNotificationSession
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 `Check` objects in this `Engine`. This also includes existing checks that may appear or disappear due to changes in the `Engine` hierarchy, 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 `CheckLookupSession`.
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	canRegisterForCheckNotifications
Description	Tests if this user can register for `Check` 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 checks 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	reliableCheckNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCheckNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCheckNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCheckNotification
Description	Acknowledge a check 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	registerForNewChecks
Description	Register for notifications of new checks. `CheckReceiver.newChecks()` is invoked when a new `Check` appears in this engine.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChecks
Description	Registers for notification of updated checks. `CheckReceiver.changedChecks()` is invoked when a check 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	registerForChangedCheck
Description	Registers for notification of an updated hold. `CheckReceiver.changedChecks()` is invoked when the specified check in this engine is changed.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check` to monitor
Errors	NOT_FOUND		a check was not found in this engine identified by the given `Id`
	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedChecks
Description	Registers for notification of deleted checks. `CheckReceiver.deletedChecks()` is invoked when a check 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	registerForDeletedCheck
Description	Registers for notification of a deleted hold. `CheckReceiver.deletedChecks()` is invoked when the specified check is deleted or removed from this engine.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check` to monitor
Errors	NOT_FOUND		a check was not found identified by the given `Id`
	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.