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

Interface ICaseMap

  • public interface ICaseMap
    Representation of a case map
    Since:
    6.7
    API:
    This is a public API.

    • Method Detail

      • getName

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

        The name of the casemap / is stored in the CMS below /CaseMaps/${id}/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 name which is defined on the case map directly will be return. If this is also empty the case map file name will be returned.

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

      • getName

        String getName​(Locale locale)
        Returns the same as getName() but with the given locale.
        Parameters:
        locale -
        Returns:
        name
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getDescription

        String getDescription()
        Returns the locale specific description of this casemap as defined in the CMS.

        The description of the casemap / is stored in the CMS below /CaseMaps/${id}/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.

        Returns:
        description
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getDescription

        String getDescription​(Locale locale)
        Returns the same as getDescription() but with the given locale.
        Parameters:
        locale -
        Returns:
        description
        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 casemap.

        E.g. The key owner of this casemap is stored in the CMS below /CaseMaps/${id}/owner.

        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 same as getLocalizedText(String) but with the given locale.
        Parameters:
        key -
        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.

      • starter

        ICaseMapStarter starter()
        Creates a starter for the case map.

        Example: Starts a case map with a parameter

         import ch.ivyteam.ivy.casemap.runtime.model.ICaseMap;
 import ch.ivyteam.ivy.casemap.runtime.CaseMapStartResult;
 
 ICaseMap caseMap = ivy.casemap.find().current();
 CaseMapStartResult result = caseMap.starter().param("myParam", "value").trigger();
        Returns:
        starter, never null
        Since:
        7.2
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getStages

        List<IStage> getStages()
        Get the stages for this case map

        Example: Get all stages of a case map:

         import ch.ivyteam.ivy.casemap.runtime.model.IStage;
 
 List<IStage> stages = ivy.casemap.findCaseMap().getStages();

        Returns:
        all stages
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.