Interface ParameterProcessorEnablerNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ParameterProcessorEnablerNotificationSession extends OsidSession

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 Details

    • getConfigurationId

      Id getConfigurationId()
      Gets the Configuration Id associated with this session.
      Returns:
      the Configuration Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getConfiguration

      Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
      Gets the Configuration associated with this session.
      Returns:
      the configuration
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForParameterProcessorEnablerNotifications

      boolean canRegisterForParameterProcessorEnablerNotifications()
      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.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedConfigurationView

      void useFederatedConfigurationView()
      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.

    • useIsolatedConfigurationView

      void useIsolatedConfigurationView()
      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.

    • reliableParameterProcessorEnablerNotifications

      void reliableParameterProcessorEnablerNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeParameterProcessorEnablerNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableParameterProcessorEnablerNotifications

      void unreliableParameterProcessorEnablerNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeParameterProcessorEnablerNotification

      void acknowledgeParameterProcessorEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a parameter processor enabler notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewParameterProcessorEnablers

      void registerForNewParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new parameter processor enablers. ParameterProcessorEnablerReceiver.newParameterProcessorEnablers() is invoked when a new ParameterProcessorEnabler appears in this configuration.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedParameterProcessorEnablers

      void registerForChangedParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated parameter processor enablers. ParameterProcessorEnablerReceiver.changedParameterProcessorEnablers() is invoked when a parameter processor enabler in this configuration is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedParameterProcessorEnabler

      void registerForChangedParameterProcessorEnabler(Id parameterProcessorEnablerProcessorId) throws OperationFailedException, PermissionDeniedException
      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:
      parameterProcessorEnablerProcessorId - the Id of the ParameterProcessorEnabler to monitor
      Throws:
      NullArgumentException - parameterProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedParameterProcessorEnablers

      void registerForDeletedParameterProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted parameter processor enablers. ParameterProcessorEnablerReceiver.deletedParameterProcessorEnablers() is invoked when a parameter processor enabler is deleted or removed from this configuration.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedParameterProcessorEnabler

      void registerForDeletedParameterProcessorEnabler(Id parameterProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      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:
      parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler to monitor
      Throws:
      NullArgumentException - parameterProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.