Package ch.ivyteam.ivy.process.extension.impl

Class ConfigurableExtensionEditor

java.lang.Object
ch.ivyteam.ivy.process.extension.impl.ConfigurableExtensionEditor
All Implemented Interfaces:
ICommonProcessExtensionConfigurationEditor, IProcessExtensionConfigurationEditorEx
Direct Known Subclasses:
AbstractProcessExtensionConfigurationEditor, UiEditorExtension
public abstract class ConfigurableExtensionEditor extends Object implements IProcessExtensionConfigurationEditorEx
Abstract base class for process extension configuration editors
Since:
25.08.2009
API:
This is a public API.

  • Method Details

    • getConfiguration

      public String getConfiguration()
      Clients are not expected to override this method.
      Specified by:
      getConfiguration in interface ICommonProcessExtensionConfigurationEditor
      Returns:
      a description of a configuration. This description will be sent to the corresponding OuterProcessBean
      See Also:
      API:
      This public API is available in Java.

    • getBeanConfiguration

      protected String getBeanConfiguration()
      API:
      This public API is available in Java.

    • setBeanConfiguration

      protected void setBeanConfiguration(String configString)
      Sets the given bean configuration to the given configuration string
      Parameters:
      configString - the configuration to set.
      API:
      This public API is available in Java.

    • getBeanConfigurationProperty

      protected String getBeanConfigurationProperty(String name)

      Gets a bean configuration property.

      This method only works correct if the configuration string contains a serialized Properties object.

      Parameters:
      name -
      Returns:
      the bean configuration property value. Maybe null.
      API:
      This public API is available in Java.

    • setBeanConfigurationProperty

      protected String setBeanConfigurationProperty(String name, String value)

      Sets a bean configuration property.

      Parameters:
      name - the name of the property to set
      value - the new value of the bean configuration property
      Returns:
      the old bean configuration property value. Maybe null.
      API:
      This public API is available in Java.

    • clearBeanConfiguration

      protected void clearBeanConfiguration()

      Clears the bean configuration and all its properties.

      Call this method before storing the bean configuration properties to flush outdated configurations. Typically called as first method in saveUiDataToConfiguration().

      API:
      This public API is available in Java.

    • getBeanConfigurationPropertyNames

      protected Set<String> getBeanConfigurationPropertyNames()
      Gets the names of the the bean configuration properties
      Returns:
      Set of property names. Never null. Maybe empty
      API:
      This public API is available in Java.

    • loadUiDataFromConfiguration

      protected void loadUiDataFromConfiguration()
      Load the data of the configuration to the ui widgets.
      Clients are expected to override this method.
      API:
      This public API is available in Java.

    • saveUiDataToConfiguration

      protected boolean saveUiDataToConfiguration()
      Save the data in the ui widgets to the configuration
      Clients are expected to override this method.
      Returns:
      true if save was successful, otherwise false
      API:
      This public API is available in Java.