Interface ValueEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to ValueEnabler objects in this Configuration . This also includes existing ValueEnablers 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 ValueEnablerLookupSession .

  • 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.

    • canRegisterForValueEnablerNotifications

      boolean canRegisterForValueEnablerNotifications()
      Tests if this user can register for ValueEnabler 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.

    • reliableValueEnablerNotifications

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

    • unreliableValueEnablerNotifications

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

    • acknowledgeValueEnablerNotification

      void acknowledgeValueEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a value 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.

    • registerForNewValueEnablers

      void registerForNewValueEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new value enablers. ValueEnablerReceiver.newValueEnablers() is invoked when a new ValueEnabler appears in this configuration.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedValueEnablers

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

    • registerForChangedValueEnabler

      void registerForChangedValueEnabler(Id valueEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated value enabler. ProvisionableReceiver.changedValueEnablers() is invoked when the specified value enabler in this configuration is changed.
      Parameters:
      valueEnablerId - the Id of the ValueEnabler to monitor
      Throws:
      NullArgumentException - valueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedValueEnablers

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

    • registerForDeletedValueEnabler

      void registerForDeletedValueEnabler(Id valueEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted value enabler. ValueEnablerReceiver.deletedValueEnablers() is invoked when the specified value enabler is deleted or removed from this configuration.
      Parameters:
      valueEnablerId - the Id of the ValueEnabler to monitor
      Throws:
      NullArgumentException - valueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.