Interface SettingNotificationSession

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

This session defines methods to receive notifications on adds/changes to Settings in this dDstributor . 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 SettingLookupSession .

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canRegisterForSettingNotifications

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

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include settings in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

      void useIsolatedSystemView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this system only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableSettingNotifications

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

    • unreliableSettingNotifications

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

    • acknowledgeSettingNotification

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

    • registerForNewSettings

      void registerForNewSettings() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new settings. SettingReceiver.newSettings() is invoked when a new Setting appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewSettingsForController

      void registerForNewSettingsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new settings for the given controller. SettingReceiver.newSettings() is invoked when a new Setting appears in this system.
      Parameters:
      controllerId - the Id of the controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSettings

      void registerForChangedSettings() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated settings. SettingReceiver.changedSettings() is invoked when a setting in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSettingsForController

      void registerForChangedSettingsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated settings for the given controller. SettingReceiver.changedSettings() is invoked when a setting in this system is changed.
      Parameters:
      controllerId - the Id of the controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSetting

      void registerForChangedSetting(Id settingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated setting. SettingReceiver.changedSettings() is invoked when the specified setting in this system is changed.
      Parameters:
      settingId - the Id of the Setting to monitor
      Throws:
      NullArgumentException - settingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSettings

      void registerForDeletedSettings() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted settings. SettingReceiver.deletedSettings() is invoked when a setting is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSettingsForController

      void registerForDeletedSettingsForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted settings for the given controller. SettingReceiver.deletedSettings() is invoked when a setting is deleted or removed from this system.
      Parameters:
      controllerId - the Id of the controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSetting

      void registerForDeletedSetting(Id settingId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted setting. SettingReceiver.deletedSettings() is invoked when the specified setting is deleted or removed from this system.
      Parameters:
      settingId - the Id of the Setting to monitor
      Throws:
      NullArgumentException - settingId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.