OSID - osid.configuration.ConfigurationNotificationSession Service Interface Definition

Interface	osid.configuration.ConfigurationNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Configurations.` Notrifications related to adding or removing of parameters are handled through the `ValueNotificationSession.` 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.
Method	canRegisterForConfigurationNotifications
Description	Tests if this user can register for `Configuration` 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	reliableConfigurationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeConfigurationNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableConfigurationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeConfigurationNotification
Description	Acknowledge a configuration 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	registerForNewConfigurations
Description	Registers for notifications of new configurations. `ConfigurationReceiver.newConfigurations()` is invoked when a new `Configuration` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConfigurations
Description	Registers for notification of updated configurations. `ConfigurationReceiver.changedConfigurations()` is invoked when a configuration is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConfiguration
Description	Registers for notifications of an update to a configuration. `ConfigurationReceiver.changedConfigurations()` is invoked when the specified `Configuration` is changed.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to monitor
Errors	NOT_FOUND		a `Configuration` was not found identified by the given `Id`
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConfigurations
Description	Registers for notification of deleted configurations. `ConfigurationReceiver.deletedConfigurations()` is invoked when a `Configuration` is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedConfiguration
Description	Registers for notifications of a deleted configuration. `ConfiguratinReceiver.deletedConfigurations()` is invoked when the specified configuration is deleted.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` to monitor
Errors	NOT_FOUND		a `Configuration` was not found identified by the given `Id`
	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConfigurationHierarchy
Description	Registers for notification of an updated configuration hierarchy structure. `ConfigurationReceiver.changedChildOfConfigurations()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConfigurationHierarchyForAncestors
Description	Registers for notification of an updated configuration hierarchy structure. `ConfigurationReceiver.changedChildOfConfigurations()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` node to monitor
Errors	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedConfigurationHierarchyForDescendants
Description	Registers for notification of an updated configuration hierarchy structure. `ConfigurationReceiver.changedChildOfConfigurations()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`configurationId`	the `Id` of the `Configuration` node to monitor
Errors	NULL_ARGUMENT		`configurationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.