ProcessInstanceImpl (Bonita Engine 7.7.3 common API)

java.lang.Object
- org.bonitasoft.engine.bpm.internal.BaseElementImpl
- - org.bonitasoft.engine.bpm.internal.NamedElementImpl
  - - org.bonitasoft.engine.bpm.process.impl.internal.ProcessInstanceImpl

All Implemented Interfaces:

Serializable, BaseElement, BonitaObject, NamedElement, ProcessInstance
```
public class ProcessInstanceImpl
extends NamedElementImpl
implements ProcessInstance
```
Author:

Baptiste Mesta, Matthieu Chaffotte, Celine Souchet

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceImpl(String name)

Constructors
Constructor and Description
`ProcessInstanceImpl(String name)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`getCallerId()` Get the identifier of the flow node instance who starts this process instance.
`String`	`getDescription()` Get the description of this process instance.
`Date`	`getEndDate()` Get the date when this process instance was finished.
`Date`	`getLastUpdate()` Get the date of the last update of this process instance.
`long`	`getProcessDefinitionId()` Get the identifier of the definition of this process.
`long`	`getRootProcessInstanceId()` Get the identifier of the root `ProcessInstance` of this process instance.
`Date`	`getStartDate()` Get the date when this process instance was started.
`long`	`getStartedBy()` Get the identifier of the user who started this process instance.
`long`	`getStartedByDelegate()` Deprecated.
`long`	`getStartedBySubstitute()` Get the identifier of the substitute user (as Process manager or Administrator) who started this process instance.
`String`	`getState()` Get the state of this process instance.
`String`	`getStringIndex1()` This field is used to extend the meta data of the process instance.
`String`	`getStringIndex2()` This field is used to extend the meta data of the process instance.
`String`	`getStringIndex3()` This field is used to extend the meta data of the process instance.
`String`	`getStringIndex4()` This field is used to extend the meta data of the process instance.
`String`	`getStringIndex5()` This field is used to extend the meta data of the process instance.
`String`	`getStringIndexLabel(int index)` The index must be between 1 and 5.
`String`	`getStringIndexLabel1()`
`String`	`getStringIndexLabel2()`
`String`	`getStringIndexLabel3()`
`String`	`getStringIndexLabel4()`
`String`	`getStringIndexLabel5()`
`void`	`setCallerId(long callerId)`
`void`	`setDescription(String description)`
`void`	`setEndDate(Date endDate)`
`void`	`setLastUpdate(Date lastUpdate)`
`void`	`setProcessDefinitionId(long processDefinitionId)`
`void`	`setRootProcessInstanceId(long rootProcessInstanceId)`
`void`	`setStartDate(Date startDate)`
`void`	`setStartedBy(long startedBy)`
`void`	`setStartedByDelegate(long startedByDelegate)` Deprecated.
`void`	`setStartedBySubstitute(long startedBySubstitute)`
`void`	`setState(String state)`
`void`	`setStringIndex1(String stringIndex1)`
`void`	`setStringIndex2(String stringIndex2)`
`void`	`setStringIndex3(String stringIndex3)`
`void`	`setStringIndex4(String stringIndex4)`
`void`	`setStringIndex5(String stringIndex5)`
`void`	`setStringIndexLabel(int index, String label)`
`void`	`setStringIndexLabel1(String stringIndexLabel1)`
`void`	`setStringIndexLabel2(String stringIndexLabel2)`
`void`	`setStringIndexLabel3(String stringIndexLabel3)`
`void`	`setStringIndexLabel4(String stringIndexLabel4)`
`void`	`setStringIndexLabel5(String stringIndexLabel5)`

Methods inherited from class org.bonitasoft.engine.bpm.internal.NamedElementImpl
equals, getName, hashCode, setName, toString

Methods inherited from class org.bonitasoft.engine.bpm.internal.BaseElementImpl
getId, setId

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement
getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement
getId

- Constructor Detail
  - ProcessInstanceImpl
```
public ProcessInstanceImpl(String name)
```
- Method Detail
  - getState
```
public String getState()
```
    Description copied from interface: ProcessInstance
    
    Get the state of this process instance.
    
    Specified by:
    
    getState in interface ProcessInstance
    
    Returns:
    
    The current state of this process instance.
    
    See Also:
    
    ProcessInstanceState
  - setState
```
public void setState(String state)
```
  - getStartDate
```
public Date getStartDate()
```
    Description copied from interface: ProcessInstance
    
    Get the date when this process instance was started.
    
    Specified by:
    
    getStartDate in interface ProcessInstance
    
    Returns:
    
    The date when this process instance was started.
  - setStartDate
```
public void setStartDate(Date startDate)
```
  - getStartedBy
```
public long getStartedBy()
```
    Description copied from interface: ProcessInstance
    
    Get the identifier of the user who started this process instance.
    
    Specified by:
    
    getStartedBy in interface ProcessInstance
    
    Returns:
    
    The identifier of the user who started this process instance.
  - setStartedBy
```
public void setStartedBy(long startedBy)
```
  - getStartedBySubstitute
```
public long getStartedBySubstitute()
```
    Description copied from interface: ProcessInstance
    
    Get the identifier of the substitute user (as Process manager or Administrator) who started this process instance.
    
    Specified by:
    
    getStartedBySubstitute in interface ProcessInstance
    
    Returns:
    
    The identifier of the substitute user (as Process manager or Administrator) who started this process instance.
  - setStartedBySubstitute
```
public void setStartedBySubstitute(long startedBySubstitute)
```
  - getStartedByDelegate
```
@Deprecated
public long getStartedByDelegate()
```
    Deprecated.
    
    Description copied from interface: ProcessInstance
    
    Get the identifier of the substitute user (as Process manager or Administrator) who started this process instance.
    
    Specified by:
    
    getStartedByDelegate in interface ProcessInstance
    
    Returns:
    
    The identifier of the substitute user (as Process manager or Administrator) who started this process instance.
  - setStartedByDelegate
```
@Deprecated
public void setStartedByDelegate(long startedByDelegate)
```
    Deprecated.
  - getEndDate
```
public Date getEndDate()
```
    Description copied from interface: ProcessInstance
    
    Get the date when this process instance was finished. It equals to null, if this process instance is not finished.
    
    Specified by:
    
    getEndDate in interface ProcessInstance
    
    Returns:
    
    The date when this process instance was finished.
  - setEndDate
```
public void setEndDate(Date endDate)
```
  - getLastUpdate
```
public Date getLastUpdate()
```
    Description copied from interface: ProcessInstance
    
    Get the date of the last update of this process instance.
    
    Specified by:
    
    getLastUpdate in interface ProcessInstance
    
    Returns:
    
    The date of the last update of this process instance.
  - setLastUpdate
```
public void setLastUpdate(Date lastUpdate)
```
  - getProcessDefinitionId
```
public long getProcessDefinitionId()
```
    Description copied from interface: ProcessInstance
    
    Get the identifier of the definition of this process.
    
    Specified by:
    
    getProcessDefinitionId in interface ProcessInstance
    
    Returns:
    
    The identifier of the definition of this process.
    
    See Also:
    
    BaseElement.getId()
  - setProcessDefinitionId
```
public void setProcessDefinitionId(long processDefinitionId)
```
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ProcessInstance
    
    Get the description of this process instance.
    
    Specified by:
    
    getDescription in interface ProcessInstance
    
    Returns:
    
    The description of this process instance.
  - setDescription
```
public void setDescription(String description)
```
  - getRootProcessInstanceId
```
public long getRootProcessInstanceId()
```
    Description copied from interface: ProcessInstance
    
    Get the identifier of the root ProcessInstance of this process instance. Is -1 if this process instance is not a child of another process instance.
    
    Specified by:
    
    getRootProcessInstanceId in interface ProcessInstance
    
    Returns:
    
    The identifier of the root process instance of this process instance.
    
    See Also:
    
    BaseElement.getId(), ArchivedElement.getSourceObjectId()
  - setRootProcessInstanceId
```
public void setRootProcessInstanceId(long rootProcessInstanceId)
```
  - getCallerId
```
public long getCallerId()
```
    Description copied from interface: ProcessInstance
    
    Get the identifier of the flow node instance who starts this process instance. Is -1 if this process instance is not a child of another process instance.
    
    Specified by:
    
    getCallerId in interface ProcessInstance
    
    Returns:
    
    The identifier of the flow node instance who starts this process instance.
    
    See Also:
    
    BaseElement.getId(), BaseElement.getId()
  - setCallerId
```
public void setCallerId(long callerId)
```
  - getStringIndex1
```
public String getStringIndex1()
```
    Description copied from interface: ProcessInstance
    
    This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no first string index.
    
    Specified by:
    
    getStringIndex1 in interface ProcessInstance
    
    Returns:
    
    The first string index of this process instance.
    
    See Also:
    
    ProcessInstance.getStringIndexLabel(int)
  - setStringIndex1
```
public void setStringIndex1(String stringIndex1)
```
  - getStringIndex2
```
public String getStringIndex2()
```
    Description copied from interface: ProcessInstance
    
    This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no second string index.
    
    Specified by:
    
    getStringIndex2 in interface ProcessInstance
    
    Returns:
    
    The second string index of this process instance.
    
    See Also:
    
    ProcessInstance.getStringIndexLabel(int)
  - setStringIndex2
```
public void setStringIndex2(String stringIndex2)
```
  - getStringIndex3
```
public String getStringIndex3()
```
    Description copied from interface: ProcessInstance
    
    This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no third string index.
    
    Specified by:
    
    getStringIndex3 in interface ProcessInstance
    
    Returns:
    
    The third string index of this process instance.
    
    See Also:
    
    ProcessInstance.getStringIndexLabel(int)
  - setStringIndex3
```
public void setStringIndex3(String stringIndex3)
```
  - getStringIndex4
```
public String getStringIndex4()
```
    Description copied from interface: ProcessInstance
    
    This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no fourth string index.
    
    Specified by:
    
    getStringIndex4 in interface ProcessInstance
    
    Returns:
    
    The fourth string index of this process instance.
    
    See Also:
    
    ProcessInstance.getStringIndexLabel(int)
  - setStringIndex4
```
public void setStringIndex4(String stringIndex4)
```
  - getStringIndex5
```
public String getStringIndex5()
```
    Description copied from interface: ProcessInstance
    
    This field is used to extend the meta data of the process instance. It's the value corresponding to the string index label. Return an empty string, if there is no fifth string index.
    
    Specified by:
    
    getStringIndex5 in interface ProcessInstance
    
    Returns:
    
    The fifth string index of this process instance.
    
    See Also:
    
    ProcessInstance.getStringIndexLabel(int)
  - setStringIndex5
```
public void setStringIndex5(String stringIndex5)
```
  - getStringIndexLabel1
```
public String getStringIndexLabel1()
```
  - setStringIndexLabel1
```
public void setStringIndexLabel1(String stringIndexLabel1)
```
  - getStringIndexLabel2
```
public String getStringIndexLabel2()
```
  - setStringIndexLabel2
```
public void setStringIndexLabel2(String stringIndexLabel2)
```
  - getStringIndexLabel3
```
public String getStringIndexLabel3()
```
  - setStringIndexLabel3
```
public void setStringIndexLabel3(String stringIndexLabel3)
```
  - getStringIndexLabel4
```
public String getStringIndexLabel4()
```
  - setStringIndexLabel4
```
public void setStringIndexLabel4(String stringIndexLabel4)
```
  - getStringIndexLabel5
```
public String getStringIndexLabel5()
```
  - setStringIndexLabel5
```
public void setStringIndexLabel5(String stringIndexLabel5)
```
  - setStringIndexLabel
```
public void setStringIndexLabel(int index,
                                String label)
```
  - getStringIndexLabel
```
public String getStringIndexLabel(int index)
```
    Description copied from interface: ProcessInstance
    
    The index must be between 1 and 5.
    
    Specified by:
    
    getStringIndexLabel in interface ProcessInstance
    
    Parameters:
    
    index - The index of the label
    
    Returns:
    
    The label of the string index corresponding to the parameter

Class ProcessInstanceImpl

Constructor Summary

Method Summary

Methods inherited from class org.bonitasoft.engine.bpm.internal.NamedElementImpl

Methods inherited from class org.bonitasoft.engine.bpm.internal.BaseElementImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

Constructor Detail

ProcessInstanceImpl

Method Detail

getState

setState

getStartDate

setStartDate

getStartedBy

setStartedBy

getStartedBySubstitute

setStartedBySubstitute

getStartedByDelegate

setStartedByDelegate

getEndDate

setEndDate

getLastUpdate

setLastUpdate

getProcessDefinitionId

setProcessDefinitionId

getDescription

setDescription

getRootProcessInstanceId

setRootProcessInstanceId

getCallerId

setCallerId

getStringIndex1

setStringIndex1

getStringIndex2

setStringIndex2

getStringIndex3

setStringIndex3

getStringIndex4

setStringIndex4

getStringIndex5

setStringIndex5

getStringIndexLabel1

setStringIndexLabel1

getStringIndexLabel2

setStringIndexLabel2

getStringIndexLabel3

setStringIndexLabel3

getStringIndexLabel4

setStringIndexLabel4

getStringIndexLabel5

setStringIndexLabel5

setStringIndexLabel

getStringIndexLabel