| Interface | osid.configuration.rules.ParameterProcessorEnablerNotificationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | This session defines methods to receive notifications on 
                adds/changes to   The two views defined in this session correspond to the 
                views in the  | ||
| Method | getConfigurationId | ||
| Description | Gets the  | ||
| Return | osid.id.Id | the  Configuration Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfiguration | ||
| Description | Gets the  | ||
| Return | osid.configuration.Configuration | the configuration | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canRegisterForParameterProcessorEnablerNotifications | ||
| Description | Tests if this user can register for  | ||
| 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  | ||
| 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 | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForNewParameterProcessorEnablers | ||
| Description | Register for notifications of new parameter processor 
                    enablers.  | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedParameterProcessorEnablers | ||
| Description | Registers for notification of updated parameter 
                    processor enablers.  | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForChangedParameterProcessorEnabler | ||
| Description | Registers for notification of an updated parameter 
                    processor enabler.  | ||
| 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.  | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | registerForDeletedParameterProcessorEnabler | ||
| Description | Registers for notification of a deleted parameter 
                    processor enabler.  | ||
| 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. | |