Package ch.ivyteam.ivy.designer.process.ui.info

Interface IProcessElementUiInformationExtension

  • public interface IProcessElementUiInformationExtension

    This extension point interface can be used to provide a short name, a name and a description for process elements. The provided information will be used by ivy to display in the process element inscription masks and process element palette.

    Since:
    04.09.2008
    API:
    This is a public API.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDescription​(String processElementClassName, Locale locale)
      Returns the description for the process element with the given process element class name and the given locale.
      String getName​(String processElementClassName, Locale locale)
      Returns the name for the process element with the given process element class name and the given locale.
      String getShortName​(String processElementClassName, Locale locale)
      Returns the short name for the process element with the given process element class name and the given locale.

    • Method Detail

      • getShortName

        String getShortName​(String processElementClassName,
                    Locale locale)

        Returns the short name for the process element with the given process element class name and the given locale.

        The short name of the process element should be no longer than 15 characters.

        If the extension is not responsible for the process element class name it must return null.

        Parameters:
        processElementClassName - the name of the process element class
        locale - the locale in which the short name should be returned
        Returns:
        short name of the process element or null
        API:
        This public API is available in Java.

      • getName

        String getName​(String processElementClassName,
               Locale locale)

        Returns the name for the process element with the given process element class name and the given locale.

        The name of the process element should be no longer than 30 characters.

        If the extension is not responsible for the process element class name it must return null.

        Parameters:
        processElementClassName - the name of the process element class
        locale - the locale in which the short name should be returned
        Returns:
        name of the process element or null
        API:
        This public API is available in Java.

      • getDescription

        String getDescription​(String processElementClassName,
                      Locale locale)

        Returns the description for the process element with the given process element class name and the given locale.

        The description of the process element should be no longer than 60 characters.

        If the extension is not responsible for the process element class name it must return null.

        Parameters:
        processElementClassName - the name of the process element class
        locale - the locale in which the short name should be returned
        Returns:
        description of the process element or null
        API:
        This public API is available in Java.