Interface ConfigurationReceiver

All Superinterfaces:
OsidReceiver
public interface ConfigurationReceiver extends OsidReceiver

The configuration receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Configuration objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfConfgurations(Id notificationId, IdList configurationIds)
    The callback for notifications of changes to children of configuration hierarchy nodes.
    void
    changedConfigurations(Id notificationId, IdList configurationIds)
    The callback for notification of updated configurations.
    void
    deletedConfigurations(Id notificationId, IdList configurationIds)
    The callback for notification of deleted configurations.
    void
    newConfigurations(Id notificationId, IdList configurationIds)
    The callback for notifications of new configurations.

    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

    • newConfigurations

      void newConfigurations(Id notificationId, IdList configurationIds)
      The callback for notifications of new configurations.
      Parameters:
      notificationId - the notification Id
      configurationIds - the Ids of the new Configurations
      Compliance:
      mandatory - This method must be implemented.

    • changedConfigurations

      void changedConfigurations(Id notificationId, IdList configurationIds)
      The callback for notification of updated configurations.
      Parameters:
      notificationId - the notification Id
      configurationIds - the Ids of the updated Configurations
      Compliance:
      mandatory - This method must be implemented.

    • deletedConfigurations

      void deletedConfigurations(Id notificationId, IdList configurationIds)
      The callback for notification of deleted configurations.
      Parameters:
      notificationId - the notification Id
      configurationIds - the Ids of the deleted Configurations
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfConfgurations

      void changedChildOfConfgurations(Id notificationId, IdList configurationIds)
      The callback for notifications of changes to children of configuration hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      configurationIds - the Ids of the Configurations whose children have changed
      Compliance:
      mandatory - This method must be implemented.