OSID - osid.configuration.rules.ValueEnablerNotificationSession Service Interface Definition

Interface	osid.configuration.rules.ValueEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `ValueEnabler` objects in this `Configuration`. This also includes existing `ValueEnablers` that may appear or disappear due to changes in the `Configuration` 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 `ValueEnablerLookupSession`.
Method	getConfigurationId
Description	Gets the `Configuration` `Id` associated with this session.
Return	`osid.id.Id`		the `Configuration Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getConfiguration
Description	Gets the `Configuration` associated with this session.
Return	`osid.configuration.Configuration`		the configuration
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForValueEnablerNotifications
Description	Tests if this user can register for `ValueEnabler` 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	useFederatedConfigurationView
Description	Federates the view for methods in this session. A federated view will include enablers in configurations which are children of this configuration in the configuration hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedConfigurationView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this configuration only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableValueEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeValueEnablerNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableValueEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeValueEnablerNotification
Description	Acknowledge a value enabler 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	registerForNewValueEnablers
Description	Register for notifications of new value enablers. `ValueEnablerReceiver.newValueEnablers()` is invoked when a new `ValueEnabler` appears in this configuration.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedValueEnablers
Description	Registers for notification of updated value enablers. `ValueEnablerReceiver.changedValueEnablers()` is invoked when a value enabler in this configuration is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedValueEnabler
Description	Registers for notification of an updated value enabler. `ProvisionableReceiver.changedValueEnablers()` is invoked when the specified value enabler in this configuration is changed.
Parameters	`osid.id.Id`	`valueEnablerId`	the `Id` of the `ValueEnabler` to monitor
Errors	NULL_ARGUMENT		`valueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedValueEnablers
Description	Registers for notification of deleted value enablers. `ValueEnablerReceiver.deletedValueEnablers()` is invoked when a value enabler is deleted or removed from this configuration.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedValueEnabler
Description	Registers for notification of a deleted value enabler. `ValueEnablerReceiver.deletedValueEnablers()` is invoked when the specified value enabler is deleted or removed from this configuration.
Parameters	`osid.id.Id`	`valueEnablerId`	the `Id` of the `ValueEnabler` to monitor
Errors	NULL_ARGUMENT		`valueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.