Package org.bonitasoft.web.client.model

Class ProcessInstance

  • All Implemented Interfaces:
    Serializable
    @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
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:
    Serialized Form

    • Constructor Detail

      • ProcessInstance

        public ProcessInstance()

    • Method Detail

      • getId

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

      • setId

        public void setId​(String id)

      • getEndDate

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

      • setEndDate

        public void setEndDate​(String endDate)

      • getFailedFlowNodes

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

      • setFailedFlowNodes

        public void setFailedFlowNodes​(String failedFlowNodes)

      • 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​(String startedBySubstitute)

      • getStart

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

      • setStart

        public void setStart​(String start)

      • getActiveFlowNodes

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

      • setActiveFlowNodes

        public void setActiveFlowNodes​(String activeFlowNodes)

      • getState

        @Nullable
public String getState()
        state: an enum that represent the state of the process instances, it can be INITIALIZING, STARTED, SUSPENDED, CANCELLED, ABORTED, COMPLETING, COMPLETED, ERROR, ABORTING
        Returns:
        state

      • setState

        public void setState​(String state)

      • getRootCaseId

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

      • setRootCaseId

        public void setRootCaseId​(String rootCaseId)

      • getStartedBy

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

      • setStartedBy

        public void setStartedBy​(String startedBy)

      • getProcessDefinitionId

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

      • setProcessDefinitionId

        public void setProcessDefinitionId​(String processDefinitionId)

      • getLastUpdateDate

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

      • setLastUpdateDate

        public void setLastUpdateDate​(String lastUpdateDate)

      • getSearchIndex1Label

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

      • setSearchIndex1Label

        public void setSearchIndex1Label​(String searchIndex1Label)

      • getSearchIndex2Label

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

      • setSearchIndex2Label

        public void setSearchIndex2Label​(String searchIndex2Label)

      • getSearchIndex3Label

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

      • setSearchIndex3Label

        public void setSearchIndex3Label​(String searchIndex3Label)

      • getSearchIndex4Label

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

      • setSearchIndex4Label

        public void setSearchIndex4Label​(String searchIndex4Label)

      • getSearchIndex5Label

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

      • setSearchIndex5Label

        public void setSearchIndex5Label​(String searchIndex5Label)

      • getSearchIndex1Value

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

      • setSearchIndex1Value

        public void setSearchIndex1Value​(String searchIndex1Value)

      • getSearchIndex2Value

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

      • setSearchIndex2Value

        public void setSearchIndex2Value​(String searchIndex2Value)

      • getSearchIndex3Value

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

      • setSearchIndex3Value

        public void setSearchIndex3Value​(String searchIndex3Value)

      • getSearchIndex4Value

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

      • setSearchIndex4Value

        public void setSearchIndex4Value​(String searchIndex4Value)

      • getSearchIndex5Value

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

      • setSearchIndex5Value

        public void setSearchIndex5Value​(String searchIndex5Value)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object