Interface ConfigurationListener


  • public interface ConfigurationListener
    Provides methods that can be implemented to support custom actions that occur based upon UI events while managing adapter instances.

    A AdapterConfigurationGuiDescriptor can have 0..n ConfigurationListeners. Each ConfigurationListener is invoked in order until EventException is thrown or all ConfigurationListeners are executed.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onDelete​(Configuration configuration)
      Implementations of this method are called when the adapter configuration is deleted.
      void onLoad()
      Implementations of this method are called when the adapter configuration is loaded within the GUI.
      void onSave​(Configuration configuration)
      Implementations of this method are called when the adapter configuration is saved.
    • Method Detail

      • onSave

        void onSave​(Configuration configuration)
             throws EventException
        Implementations of this method are called when the adapter configuration is saved. A thrown EventException stops processing. Adapter instances defined prior to this instance completed execution of their ConfigurationListener. ConfigurationListeners of adapter instances subsequent to this instance are not invoked.
        Parameters:
        configuration - the Configuration object constructed from values entered by the user via the GUI.
        Throws:
        EventException - if an error occurs during execution.
      • onDelete

        void onDelete​(Configuration configuration)
               throws EventException
        Implementations of this method are called when the adapter configuration is deleted. A thrown EventException stops processing. Adapter instances defined prior to this instance completed execution of their ConfigurationListener. ConfigurationListeners of adapter instances subsequent to this instance are not invoked.
        Parameters:
        configuration - the Configuration object constructed from values entered by the user via the GUI.
        Throws:
        EventException - if an error occurs during execution.
      • onLoad

        void onLoad()
             throws EventException
        Implementations of this method are called when the adapter configuration is loaded within the GUI.
        Throws:
        EventException - if an error occurs during execution.