Package ch.ivyteam.ivy.casemap.runtime.model

Interface IStage

  • public interface IStage
    Provides information about a stage in a case map.

    Since:
    6.7
    See Also:
    ICaseMap.getStages()
    API:
    This is a public API.

    • Method Detail

      • getName

        String getName()
        Returns the locale specific name of this stage as defined in the CMS.

        The name of the stage / is stored in the CMS below /Stages/${stageId}/name.

        The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

        If the CMS entry does not exists or is empty, the stage id is returned.

        Returns:
        the name of this stage
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getName

        String getName​(Locale locale)
        Returns the name of this stage as defined in the CMS for the given locale.

        The name of the stage / is stored in the CMS below /Stages/${stageId}/name.

        The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

        If the CMS entry does not exists or is empty, the stage id is returned.

        Parameters:
        locale - the requested locale
        Returns:
        the name of this stage
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getLocalizedText

        String getLocalizedText​(String key)
        Returns the localized text from the CMS for the given key under this stage.

        E.g. The key description of the stage Finance/Invoices is stored in the CMS below /Stages/${stageId}/description.

        The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

        If the CMS entry does not exists then an empty string will be returned.

        Parameters:
        key - The key of the requested entry
        Returns:
        the text for the given key of this stage as defined in the CMS.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getLocalizedText

        String getLocalizedText​(String key,
                        Locale locale)
        Returns the localized text from the CMS for the given key under this stage.

        E.g. The key description of the stage Finance/Invoices is stored in the CMS below /Stages/${stageId}/description.

        The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

        If the CMS entry does not exists then an empty string will be returned.

        Parameters:
        key - The key of the requested entry
        locale - the requested locale
        Returns:
        the text for the given key of this stage as defined in the CMS.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getIcon

        Icon getIcon()
        Returns the icon of the sage.

        Currently only css class icons are supported. To display the icon in your HTML dialog include the "Font Awesome" icon library and display the icon like this: <i class="#{stage.getIcon().getCssClass()}" />

        Returns:
        the stage icon, never null.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • isTerminating

        boolean isTerminating()
        Returns true if this stage is a terminating stage.

        This means that the execution of the case map does not automatically continue on the next stage.

        Returns:
        true if stage is terminating
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.