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

Interface	osid.configuration.rules.ParameterProcessorEnablerNotificationSession
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 `ParameterProcessorEnabler` objects in this `Configuration`. This also includes existing `ParameterProcessorEnablers` 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 `ParameterProcessorEnablerLookupSession`.
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	canRegisterForParameterProcessorEnablerNotifications
Description	Tests if this user can register for `ParameterProcessorEnabler` 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	reliableParameterProcessorEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeParameterProcessorEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableParameterProcessorEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeParameterProcessorEnablerNotification
Description	Acknowledge a parameter processor 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	registerForNewParameterProcessorEnablers
Description	Register for notifications of new parameter processor enablers. `ParameterProcessorEnablerReceiver.newParameterProcessorEnablers()` is invoked when a new `ParameterProcessorEnabler` appears in this configuration.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedParameterProcessorEnablers
Description	Registers for notification of updated parameter processor enablers. `ParameterProcessorEnablerReceiver.changedParameterProcessorEnablers()` is invoked when a parameter processor 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	registerForChangedParameterProcessorEnabler
Description	Registers for notification of an updated parameter processor enabler. `ProvisionableReceiver.changedParameterProcessorEnablers()` is invoked when the specified parameter processor enabler in this configuration is changed.
Parameters	`osid.id.Id`	`parameterProcessorEnablerProcessorId`	the `Id` of the `ParameterProcessorEnabler` to monitor
Errors	NULL_ARGUMENT		`parameterProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedParameterProcessorEnablers
Description	Registers for notification of deleted parameter processor enablers. `ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers()` is invoked when a parameter processor 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	registerForDeletedParameterProcessorEnabler
Description	Registers for notification of a deleted parameter processor enabler. `ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers()` is invoked when the specified parameter processor enabler is deleted or removed from this configuration.
Parameters	`osid.id.Id`	`parameterProcessorEnablerId`	the `Id` of the `ParameterProcessorEnabler` to monitor
Errors	NULL_ARGUMENT		`parameterProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.