OSID - osid.configuration.ParameterNotificationSession Service Interface Definition

Interface	osid.configuration.ParameterNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Configurations` and their properties. 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 `federateParameterView()` and `isolateParameterView()` 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	canRegisterForParameterNotifications
Description	Tests if this user can register for `Parameter` 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 registries 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	reliableParameterNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeParameterNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableParameterNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeParameterNotification
Description	Acknowledge a parameter 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	registerForNewParameters
Description	Assigns a callback for notifications of new parameters. `ParameterReceiver.newParameters()` is invoked when a new `Parameter` 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	registerForChangedParameters
Description	Assigns a callback for notification of updated parameters. `ParameterReceiver.changedParameters()` is invoked when a `Parameter` 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	registerForChangedParameter
Description	Assigns a callback for notifications of an update to a parameter. `ParamaterReceiver.changedParameters()` is invoked when the specified `Parameter` is changed in 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	registerForDeletedParameters
Description	Assigns a callback for notification of deleted parameters. `ParameterReceiver.deletedParamaters()` is invoked when a `Parameter` 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	registerForDeletedParameter
Description	Assigns a callback for notifications of a deleted parameter. `ParameterReceiver.deletedParameters()` is invoked when the specified `Parameter` is deleted or 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.