Package ch.ivyteam.ivy.bpm.engine.client

Class History

java.lang.Object
ch.ivyteam.ivy.bpm.engine.client.History
public class History extends Object

Process elements that were executed

Example:


 var startElement = BpmElement.processName("processUnderTest").name("start.ivp");
 var endElement = BpmElement.processName("processUnderTest").name("end");
 var result = bpmClient.start().process(startElement).execute();
 assertThat(result.history().elements()).contains(startEelement, endElement);
Since:
9.1
API:
This is a public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    elementNames()
    Returns a list with the names of all executed process elements
    List<PID>
    elementPids()
    Returns a list with the pids of all executed process elements
    List<BpmElement>
    elements()
    Returns a list with all executed process elements

  • Method Details

    • elements

      public List<BpmElement> elements()

      Returns a list with all executed process elements

      Example:

      
 var startElement = BpmElement.processName("processUnderTest").name("start.ivp");
 var endElement = BpmElement.processName("processUnderTest").name("end");
 var result = bpmClient.start().process(startElement).execute();
 assertThat(result.history().elements()).contains(startEelement, endElement);
      Returns:
      list of executed process elements
      API:
      This public API is available in Java.

    • elementNames

      public List<String> elementNames()

      Returns a list with the names of all executed process elements

      Example:

      
 var startElement = BpmElement.processName("processUnderTest").name("start.ivp");
 var result = bpmClient.start().process(startElement).execute();
 assertThat(result.history().elementNames()).contains("start.ivp", "sendMails", "end");
      Returns:
      list of names
      API:
      This public API is available in Java.

    • elementPids

      public List<PID> elementPids()

      Returns a list with the pids of all executed process elements

      Example:

      
 var startElement = BpmElement.processName("processUnderTest").name("start.ivp");
 var result = bpmClient.start().process(startElement).execute();
 assertThat(result.history().elementPids()).contains(PID.of("14C7A266FC6A4DC2-f10"));
      Returns:
      list of pids
      API:
      This public API is available in Java.