Package ch.ivyteam.ivy.casemap.runtime

Interface ICaseMapService

  • public interface ICaseMapService
    The ICaseMapService is the entry point to the case map related public API.
    Since:
    6.7
    API:
    This is a public API.

    • Method Detail

      • getCaseMapService

        ICaseMapService getCaseMapService​(IBusinessCase businessCase)
        Get the case map service for the given context

        Example: Get all stages of a case map:

         import ch.ivyteam.ivy.workflow.businesscase.IBusinessCase;
 import ch.ivyteam.ivy.casemap.runtime.model.IStage;
 
 IBusinessCase myBusinessCase = ...;
 List<IStage> stages = ivy.casemap.getCaseMapService(myBusinessCase).findCaseMap().getStages();

        Parameters:
        businessCase -
        Returns:
        case map service of the given business case
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getCaseMapService

        ICaseMapService getCaseMapService​(IBusinessCase businessCase,
                                  IUserToken userToken)
        Get the case map service for the given context

        Example: Get all stages of a case map:

         import ch.ivyteam.ivy.workflow.businesscase.IBusinessCase;
 import ch.ivyteam.ivy.casemap.runtime.model.IStage;
 
 IBusinessCase myBusinessCase = ...;
 List<IStage> stages = ivy.casemap.getCaseMapService(myBusinessCase, ivy.session.getSessionUser().getUserToken()).findCaseMap().getStages();

        Parameters:
        businessCase -
        userToken -
        Returns:
        case map service of the given business case
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • find

        ICaseMapFinder find()
        Returns a case map finder, which can be used to find a case map. Example:
         import ch.ivyteam.ivy.casemap.runtime.model.ICaseMap;

 ICaseMap caseMap = ivy.casemap.find().byPath("Case Maps/MyCaseMap");
        Returns:
        case map finder, never null
        Since:
        7.2
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • findCurrentStage

        IStage findCurrentStage()
        Get the current stage of the business case

        If you want to change the context:

        Example:

         import ch.ivyteam.ivy.casemap.runtime.model.IStage;

 IStage stage = ivy.casemap.findCurrentStage();
        Returns:
        stage of the business case, null if business case has no case map
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • findStartableSideSteps

        List<IStartableSideStep> findStartableSideSteps()
        Gets the startable sidesteps for the given business case and user combination

        If you want to change the context:

        Example:

         import ch.ivyteam.ivy.casemap.runtime.model.IStartableSideStep;
 List<IStartableSideStep> sideSteps = ivy.casemap.findStartableSideSteps();
        Returns:
        startable sidesteps for the given context
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.