OSID - osid.rules.RuleNotificationSession Service Interface Definition

Interface	osid.rules.RuleNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.rules.RulesManager`
Used By	`osid.rules.RulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Rules`. 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.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRuleNotifications
Description	Tests if this user can register for `Rule` 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 notifications for rules 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	reliableRuleNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRuleNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRuleNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRuleNotification
Description	Acknowledge a rule 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	registerForNewRules
Description	Register for notifications of new rules. `RuleReceiver.newRules()` is invoked when a new `Rule` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRules
Description	Registers for notification of updated rules. `RuleReceiver.changedRules()` is invoked when a rule is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRule
Description	Registers for notification of an updated rule. `RuleReceiver.changedRules()` is invoked when the specified rule is changed.
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule` to monitor
Errors	NULL_ARGUMENT		`ruleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRules
Description	Registers for notification of deleted rules. `RuleReceiver.deletedRules()` is invoked when a rule is removed from this engine.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRule
Description	Registers for notification of a deleted rule. `RuleReceiver.deletedRules()` is invoked when the specified rule is removed from this engine.
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule` to monitor
Errors	NULL_ARGUMENT		`ruleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.