Package ch.ivyteam.ivy.process.call

Class SubProcessRunner

java.lang.Object
ch.ivyteam.ivy.process.call.SubProcessRunner
public class SubProcessRunner extends Object
Allows to find and execute a sub process
For a nicer fluent PublicAPI see SubProcessCall
API:
This is a public API.

  • Method Details

    • findSubProcessStarts

      public static List<ISubProcessStart> findSubProcessStarts(SubProcessSearchFilter configuration)
      For a nicer fluent PublicAPI see SubProcessCall Finds sub processes on the basis of a SubProcessSearchFilter.

      Example finds a sub process:
      SubProcessSearchFilter filter = SubProcessSearchFilter.create()
      .setProcessPath("testSub")
      .setSignature("call(String)")
      .toFilter();
      List foundSubProcesses = SubProcessRunner.findSubProcessStarts(filter);

      Parameters:
      configuration - search configuration SubProcessSearchFilter
      Returns:
      a list with the found sub processes
      API:
      This public API is available in Java.

    • execute

      public static Map<String,Object> execute(ISubProcessStart subProcessStart)
      For a nicer fluent PublicAPI see SubProcessCall
      Executes a sub process without parameters.

      Example starts a sub process without parameters:
      Map outParameters = SubProcessRunner.call(subProcessStart);

      Parameters:
      subProcessStart - SubProcessStart see findSubProcessStarts(SubProcessSearchFilter)
      Returns:
      the output parameters of the process
      API:
      This public API is available in Java.

    • execute

      public static Map<String,Object> execute(ISubProcessStart subProcessStart, Map<String,? extends Object> inputParameter)
      For a nicer fluent PublicAPI see SubProcessCall
      Executes a sub process with parameters.

      Example starts a sub process with parameters:
      Map inputParams = new HashMap();
      inputParams.put("name","Bill");
      Map outParameters = SubProcessRunner.execute(subProcessStart, inputParams);

      Parameters:
      subProcessStart - SubProcessStart see findSubProcessStarts(SubProcessSearchFilter)
      inputParameter - the input parameters
      Returns:
      the output parameters of the sub process
      API:
      This public API is available in Java.

    • exec

      public static Object[] exec(ISubProcessStart subProcessStart, Object... args)
      For a nicer fluent PublicAPI see SubProcessCall
      Executes a sub process with parameters.

      Example starts a sub process with arguments:
      List outParameters = SubProcessRunner.exec(subProcessStart, "Bill");

      Parameters:
      subProcessStart - SubProcessStart see findSubProcessStarts(SubProcessSearchFilter)
      args - the input parameter
      Returns:
      the output parameters of the sub process
      API:
      This public API is available in Java.