Package org.bonitasoft.web.client.model

Class ProcessInstance

java.lang.Object
org.bonitasoft.web.client.model.ProcessInstance
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.12.0") public class ProcessInstance extends Object implements Serializable
ProcessInstance (Case) is an instance of a process. When you start a process, it creates a process instances.
See Also:

  • Field Details

  • Constructor Details

    • ProcessInstance

      public ProcessInstance()

  • Method Details

    • id

      public ProcessInstance id(@Nullable String id)

    • getId

      @Nullable public String getId()
      the identifier of the ProcessInstance (Case)
      Returns:
      id

    • setId

      public void setId(@Nullable String id)

    • endDate

      public ProcessInstance endDate(@Nullable String endDate)

    • getEndDate

      @Nullable public String getEndDate()
      the date set when the process instance is closed
      Returns:
      endDate

    • setEndDate

      public void setEndDate(@Nullable String endDate)

    • failedFlowNodes

      public ProcessInstance failedFlowNodes(@Nullable String failedFlowNodes)

    • getFailedFlowNodes

      @Nullable public String getFailedFlowNodes()
      count of failed flow nodes if parameter n=failedFlowNodes is given
      Returns:
      failedFlowNodes

    • setFailedFlowNodes

      public void setFailedFlowNodes(@Nullable String failedFlowNodes)

    • startedBySubstitute

      public ProcessInstance startedBySubstitute(@Nullable String startedBySubstitute)

    • getStartedBySubstitute

      @Nullable public String getStartedBySubstitute()
      the identifier of the substitute user (as Process manager or Administrator) who started the process. It can be also the substitute user if d=startedBySubstitute is given.
      Returns:
      startedBySubstitute

    • setStartedBySubstitute

      public void setStartedBySubstitute(@Nullable String startedBySubstitute)

    • start

      public ProcessInstance start(@Nullable String start)

    • getStart

      @Nullable public String getStart()
      the starting date of the case
      Returns:
      start

    • setStart

      public void setStart(@Nullable String start)

    • activeFlowNodes

      public ProcessInstance activeFlowNodes(@Nullable String activeFlowNodes)

    • getActiveFlowNodes

      @Nullable public String getActiveFlowNodes()
      count of active flow nodes if parameter n=activeFlowNodes is given
      Returns:
      activeFlowNodes

    • setActiveFlowNodes

      public void setActiveFlowNodes(@Nullable String activeFlowNodes)

    • state

      public ProcessInstance state(@Nullable ProcessInstance.StateEnum state)

    • getState

      @Nullable public ProcessInstance.StateEnum getState()
      state: an enum that represent the state of the process instances
      Returns:
      state

    • setState

      public void setState(@Nullable ProcessInstance.StateEnum state)

    • rootCaseId

      public ProcessInstance rootCaseId(@Nullable String rootCaseId)

    • getRootCaseId

      @Nullable public String getRootCaseId()
      the identifier of the container of the case
      Returns:
      rootCaseId

    • setRootCaseId

      public void setRootCaseId(@Nullable String rootCaseId)

    • startedBy

      public ProcessInstance startedBy(@Nullable String startedBy)

    • getStartedBy

      @Nullable public String getStartedBy()
      the identifier of the user who started the case
      Returns:
      startedBy

    • setStartedBy

      public void setStartedBy(@Nullable String startedBy)

    • processDefinitionId

      public ProcessInstance processDefinitionId(@Nullable String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      the identifier of the process related of the case
      Returns:
      processDefinitionId

    • setProcessDefinitionId

      public void setProcessDefinitionId(@Nullable String processDefinitionId)

    • lastUpdateDate

      public ProcessInstance lastUpdateDate(@Nullable String lastUpdateDate)

    • getLastUpdateDate

      @Nullable public String getLastUpdateDate()
      the date of the last update done on the case
      Returns:
      lastUpdateDate

    • setLastUpdateDate

      public void setLastUpdateDate(@Nullable String lastUpdateDate)

    • searchIndex1Label

      public ProcessInstance searchIndex1Label(@Nullable String searchIndex1Label)

    • getSearchIndex1Label

      @Nullable public String getSearchIndex1Label()
      the 1st search index label (from 6.5, in Subscription editions only)
      Returns:
      searchIndex1Label

    • setSearchIndex1Label

      public void setSearchIndex1Label(@Nullable String searchIndex1Label)

    • searchIndex2Label

      public ProcessInstance searchIndex2Label(@Nullable String searchIndex2Label)

    • getSearchIndex2Label

      @Nullable public String getSearchIndex2Label()
      the 2nd search index label (from 6.5, in Subscription editions only)
      Returns:
      searchIndex2Label

    • setSearchIndex2Label

      public void setSearchIndex2Label(@Nullable String searchIndex2Label)

    • searchIndex3Label

      public ProcessInstance searchIndex3Label(@Nullable String searchIndex3Label)

    • getSearchIndex3Label

      @Nullable public String getSearchIndex3Label()
      the 3rd search index label (from 6.5, in Subscription editions only)
      Returns:
      searchIndex3Label

    • setSearchIndex3Label

      public void setSearchIndex3Label(@Nullable String searchIndex3Label)

    • searchIndex4Label

      public ProcessInstance searchIndex4Label(@Nullable String searchIndex4Label)

    • getSearchIndex4Label

      @Nullable public String getSearchIndex4Label()
      the 4th search index label (from 6.5, in Subscription editions only)
      Returns:
      searchIndex4Label

    • setSearchIndex4Label

      public void setSearchIndex4Label(@Nullable String searchIndex4Label)

    • searchIndex5Label

      public ProcessInstance searchIndex5Label(@Nullable String searchIndex5Label)

    • getSearchIndex5Label

      @Nullable public String getSearchIndex5Label()
      the 5th search index label (from 6.5, in Subscription editions only)
      Returns:
      searchIndex5Label

    • setSearchIndex5Label

      public void setSearchIndex5Label(@Nullable String searchIndex5Label)

    • searchIndex1Value

      public ProcessInstance searchIndex1Value(@Nullable String searchIndex1Value)

    • getSearchIndex1Value

      @Nullable public String getSearchIndex1Value()
      the 1st search index value (from 6.5, in Subscription editions only)
      Returns:
      searchIndex1Value

    • setSearchIndex1Value

      public void setSearchIndex1Value(@Nullable String searchIndex1Value)

    • searchIndex2Value

      public ProcessInstance searchIndex2Value(@Nullable String searchIndex2Value)

    • getSearchIndex2Value

      @Nullable public String getSearchIndex2Value()
      the 2nd search index value (from 6.5, in Subscription editions only)
      Returns:
      searchIndex2Value

    • setSearchIndex2Value

      public void setSearchIndex2Value(@Nullable String searchIndex2Value)

    • searchIndex3Value

      public ProcessInstance searchIndex3Value(@Nullable String searchIndex3Value)

    • getSearchIndex3Value

      @Nullable public String getSearchIndex3Value()
      the 3rd search index value (from 6.5, in Subscription editions only)
      Returns:
      searchIndex3Value

    • setSearchIndex3Value

      public void setSearchIndex3Value(@Nullable String searchIndex3Value)

    • searchIndex4Value

      public ProcessInstance searchIndex4Value(@Nullable String searchIndex4Value)

    • getSearchIndex4Value

      @Nullable public String getSearchIndex4Value()
      the 4th search index value (from 6.5, in Subscription editions only)
      Returns:
      searchIndex4Value

    • setSearchIndex4Value

      public void setSearchIndex4Value(@Nullable String searchIndex4Value)

    • searchIndex5Value

      public ProcessInstance searchIndex5Value(@Nullable String searchIndex5Value)

    • getSearchIndex5Value

      @Nullable public String getSearchIndex5Value()
      the 5th search index value (from 6.5, in Subscription editions only)
      Returns:
      searchIndex5Value

    • setSearchIndex5Value

      public void setSearchIndex5Value(@Nullable String searchIndex5Value)

    • callerId

      public ProcessInstance callerId(@Nullable String callerId)

    • getCallerId

      @Nullable public String getCallerId()
      the identifier of the BPM entity who started the process. E.g. the call activity instance Id if it was started by a call activity or -1 if it was started by a user (since version 10.3 - 2025.1)
      Returns:
      callerId

    • setCallerId

      public void setCallerId(@Nullable String callerId)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object