Package ch.ivyteam.ivy.casemap.runtime

Interface ICaseMapFinder

  • public interface ICaseMapFinder
    Case Map Finder.
    Since:
    7.2
    API:
    This is a public API.

    • Method Detail

      • current

        ICaseMap current()
        Get the case map of the current business case.

        Example:

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

 ICaseMap caseMap = ivy.casemap.find().current();
        Returns:
        case map of the business case, null if the business case has no case map
        See Also:
        byBusinessCase(IBusinessCase)
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • byBusinessCase

        ICaseMap byBusinessCase​(IBusinessCase businessCase)
        Get the case map of the given business case.

        Example:

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

 ICaseMap caseMap = ivy.casemap.find().byBusinessCase(ivy.case.getBusinessCase());
        Returns:
        case map of the business case, null if the business case has no case map
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • byId

        ICaseMap byId​(String id)
        Get the case map with the given id.

        Example:

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

 ICaseMap caseMap = ivy.casemap.find().byId("my-casemap-id");
        Parameters:
        id - case map id
        Returns:
        case map, null if this case map does not exist.
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • byUniqueId

        ICaseMap byUniqueId​(String uuid)
        Get the case map with the given unique id (uuid).

        Example:

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

 ICaseMap caseMap = ivy.casemap.find().byUniqueId("3bfa3cc9-9b53-45a8-9a4f-2c3e4a33d7a1");
        Parameters:
        uuid - case map uuid
        Returns:
        case map, null if this case map does not exist.
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • byPath

        ICaseMap byPath​(String path)
        Get the case map with the given path.

        Example:

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

 ICaseMap caseMap = ivy.casemap.find().byPath("Case Maps/MyCaseMap");
        Parameters:
        path - case map path in the project
        Returns:
        case map, null if this case map does not exist.
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.