Package ch.ivyteam.ivy.process.extension

Interface IProcessExtensionConfigurationEditorEnvironment

public interface IProcessExtensionConfigurationEditorEnvironment

The process extension configuration editor can access its environment over this interface.

At the moment the editor can get server extensions with the method getServerExtension(String)

Since:
28.08.2008
API:
This is a public API.

  • Method Details

    • getProcessModelVersion

      IProcessModelVersion getProcessModelVersion()
      Returns:
      the process model version of the process where the extension element is located
      API:
      This public API is available in Java.

    • getServerExtension

      IServerExtension getServerExtension(String serverExtensionIdentifier)
      Gets the server extension with the given server extension identifier. For more information about server extensions see IServerExtension
      Parameters:
      serverExtensionIdentifier - the server extension identifier
      Returns:
      server extension identifier or null if no server extension is installed with the given identifier.
      API:
      This public API is available in Java.

    • createIvyScriptEditor

      @Deprecated(forRemoval=true, since="9.4") IIvyScriptEditor createIvyScriptEditor()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use UiEditorExtension.initUiFields(ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder) instead.
      Returns:
      AWT ivy script editor
      API:
      This public API is available in Java.

    • createIvyScriptEditor

      @Deprecated(forRemoval=true, since="9.4") IIvyScriptEditor createIvyScriptEditor(List<ch.ivyteam.ivy.process.extension.IProcessExtensionConfigurationEditorEnvironment.Variable> inputVariables, List<ch.ivyteam.ivy.process.extension.IProcessExtensionConfigurationEditorEnvironment.Variable> environmentVariables)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use UiEditorExtension.initUiFields(ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder) instead.
      Creates an ivy script editor
      Parameters:
      inputVariables - the input variable that should be available inside the script. Maybe null.
      environmentVariables - the environment variable that should be available inside the script. Maybe null.
      Returns:
      ivy script editor the environment variable that should be available inside the script.
      API:
      This public API is available in Java.

    • createIvyScriptEditor

      @Deprecated(forRemoval=true, since="9.4") IIvyScriptEditor createIvyScriptEditor(List<ch.ivyteam.ivy.process.extension.IProcessExtensionConfigurationEditorEnvironment.Variable> inputVariables, List<ch.ivyteam.ivy.process.extension.IProcessExtensionConfigurationEditorEnvironment.Variable> environmentVariables, String resultTypeName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use UiEditorExtension.initUiFields(ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder) instead.
      Creates an ivy script editor
      Parameters:
      inputVariables - the input variable that should be available inside the script. Maybe null.
      environmentVariables - the environment variable that should be available inside the script. Maybe null.
      resultTypeName - the name of the type the script should evaluate to. Maybe null.
      Returns:
      ivy script editor the environment variable that should be available inside the script.
      API:
      This public API is available in Java.

    • createIvyScriptEditor

      @Deprecated(forRemoval=true, since="9.4") IIvyScriptEditor createIvyScriptEditor(List<ch.ivyteam.ivy.process.extension.IProcessExtensionConfigurationEditorEnvironment.Variable> inputVariables, List<ch.ivyteam.ivy.process.extension.IProcessExtensionConfigurationEditorEnvironment.Variable> environmentVariables, String resultTypeName, int rows, boolean buttonsVertical, int verticalScrollbarPolicy, int horizontalScrollbarPolicy)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use UiEditorExtension.initUiFields(ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder) instead.
      Creates an ivy script editor
      Parameters:
      inputVariables - the input variable that should be available inside the script. Maybe null.
      environmentVariables - the environment variable that should be available inside the script. Maybe null.
      resultTypeName - the name of the type the script should evaluate to. Maybe null.
      rows - the number of rows the editor should have at least
      buttonsVertical - if true the smart buttons are located vertical, otherwise horizontal
      verticalScrollbarPolicy - the vertical scrollbar policy. See ScrollPaneConstants for more information.
      horizontalScrollbarPolicy - the horizontal scrollbar policy. See ScrollPaneConstants for more information.
      Returns:
      ivy script editor the environment variable that should be available inside the script.
      API:
      This public API is available in Java.