Interface SettingReceiver

All Superinterfaces:
OsidReceiver
public interface SettingReceiver extends OsidReceiver

The setting receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedSettings(Id notificationId, IdList settingIds)
    The callback for notification of updated settings.
    void
    deletedSettings(Id notificationId, IdList settingIds)
    The callback for notification of deleted settings.
    void
    newSettings(Id notificationId, IdList settingIds)
    The callback for notifications of new settings.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newSettings

      void newSettings(Id notificationId, IdList settingIds)
      The callback for notifications of new settings.
      Parameters:
      notificationId - the notification Id
      settingIds - the Ids of the new Settings
      Compliance:
      mandatory - This method must be implemented.

    • changedSettings

      void changedSettings(Id notificationId, IdList settingIds)
      The callback for notification of updated settings.
      Parameters:
      notificationId - the notification Id
      settingIds - the Ids of the updated Settings
      Compliance:
      mandatory - This method must be implemented.

    • deletedSettings

      void deletedSettings(Id notificationId, IdList settingIds)
      The callback for notification of deleted settings.
      Parameters:
      notificationId - the notification Id
      settingIds - the Ids of the deleted Settings
      Compliance:
      mandatory - This method must be implemented.