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:
UiEditorExtension
@Deprecated(forRemoval=true, since="11.2") public abstract class ConfigurableExtensionEditor extends Object implements IProcessExtensionConfigurationEditorEx
Deprecated, for removal: This API element is subject to removal in a future version.
directly bind your widgets to a config value via ExtensionUiBuilder.scriptField(String) or ExtensionUiBuilder.textField(String)
Abstract base class for process extension configuration editors
Since:
25.08.2009
API:
This is a public API.

  • Method Details

    • getConfiguration

      @Deprecated(forRemoval=true, since="11.2") public String getConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(forRemoval=true, since="11.2") protected String getBeanConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      API:
      This public API is available in Java.

    • setBeanConfiguration

      @Deprecated(forRemoval=true, since="11.2") protected void setBeanConfiguration(String configString)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(forRemoval=true, since="11.2") protected String getBeanConfigurationProperty(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.

      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

      @Deprecated(forRemoval=true, since="11.2") protected String setBeanConfigurationProperty(String name, String value)
      Deprecated, for removal: This API element is subject to removal in a future version.

      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

      @Deprecated(forRemoval=true, since="11.2") protected void clearBeanConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.

      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

      @Deprecated(forRemoval=true, since="11.2") protected Set<String> getBeanConfigurationPropertyNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(forRemoval=true, since="11.2") protected void loadUiDataFromConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

      @Deprecated(forRemoval=true, since="11.2") protected boolean saveUiDataToConfiguration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.