OSID - osid.configuration.ValueNotificationSession Service Interface Definition

Interface	osid.configuration.ValueNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on changes to `Values.` A particular value in a set may have been added or deleted, but all changes appear as a change to a parameter. Once a change notification is received, the new value list can be obtained through the `ValueLookupSession.` This session is intended for adapters and providers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. Two views are defined; federated: parameters defined in configurations that are a parent of this configuration in the configuration hierarchy are included for notifications isolated: notifications are restricted to parameters are defined to within this configuration The methods `federateValuerView()` and `isolateValueView()` behave as a radio group and one should be selected before invoking any lookup methods.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForValueNotifications
Description	Tests if this user can register for `Value` 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 parameters in configurations of which this configuration is a child 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 for parameter values to this configuration only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableValueNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeValueNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableValueNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeValueNotification
Description	Acknowledge a value 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	registerForNewValues
Description	Assigns a callback for notifications of new values. `ValueReceiver.newValues()` is invoked when a new `Value` is added to this configuration.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewValuesForParameter
Description	Assigns a callback for notifications of new values for the given parameter. `ValueReceiver.newValues()` is invoked when a new `Value` is added to this configuration.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to monitor
Errors	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedValues
Description	Assigns a callback for notification of updated parameter values in this configuration. `ValueReceiver.changedValues()` is invoked when a `Value` is changed in this configuration.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedValuesForParameter
Description	Assigns a callback for notifications of changed values for the given parameter. `ValueReceiver.changedValues()` is invoked when a `Value` is updated to this configuration.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to monitor
Errors	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedValue
Description	Assigns a callback for notifications of an update to a value in this configuration. `ValueReceiver.changedValues()` is invoked when the specified `Value` is updated in this configuration.
Parameters	`osid.id.Id`	`valueId`	the `Id` of the `Value` to monitor
Errors	NULL_ARGUMENT		`valueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedValues
Description	Assigns a callback for notification of deleted values in this configuration. `ValueReceiver.changedValues()` is invoked when a `Value` is removed from this configuration.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedValuesForParameter
Description	Assigns a callback for notifications of changed values for the given parameter. `ValueReceiver.changedValues()` is invoked when a `Value` is removed from this configuration.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to monitor
Errors	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedValue
Description	Assigns a callback for notifications of an update to a value in this configuration. `ValueReceiver.changedValues()` is invoked when the specified `Value` is removed from this configuration.
Parameters	`osid.id.Id`	`valueId`	the `Id` of the `Value` to monitor
Errors	NULL_ARGUMENT		`valueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.