SProcessInstanceImpl (Bonita Engine 7.8.3 server API)

java.lang.Object
- org.bonitasoft.engine.core.process.instance.model.impl.SPersistenceObjectImpl
- - org.bonitasoft.engine.core.process.instance.model.impl.SNamedElementImpl
  - - org.bonitasoft.engine.core.process.instance.model.impl.SProcessInstanceImpl

All Implemented Interfaces:

Serializable, SFlowElementsContainer, SNamedElement, SProcessInstance, PersistentObject
```
public class SProcessInstanceImpl
extends SNamedElementImpl
implements SProcessInstance
```
Author:

Elias Ricken de Medeiros, Yanyan Liu, Matthieu Chaffotte, Celine Souchet

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SProcessInstanceImpl()`
`SProcessInstanceImpl(SProcessDefinition definition)`
`SProcessInstanceImpl(String name, long processDefinitionId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`long`	`getCallerId()` Get the id of the call activity that started the process instance.
`SFlowNodeType`	`getCallerType()` Get the caller's SFlowNodeType.
`long`	`getContainerId()`
`SFlowElementsContainerType`	`getContainerType()`
`String`	`getDescription()`
`String`	`getDiscriminator()`
`long`	`getEndDate()`
`long`	`getInterruptingEventId()` Get the id of the end error event that interrupted the process instance.
`long`	`getLastUpdate()`
`long`	`getProcessDefinitionId()`
`long`	`getRootProcessInstanceId()`
`long`	`getStartDate()`
`long`	`getStartedBy()`
`long`	`getStartedBySubstitute()`
`SStateCategory`	`getStateCategory()`
`int`	`getStateId()`
`String`	`getStringIndex1()`
`String`	`getStringIndex2()`
`String`	`getStringIndex3()`
`String`	`getStringIndex4()`
`String`	`getStringIndex5()`
`boolean`	`hasBeenInterruptedByEvent()`
`int`	`hashCode()`
`boolean`	`isRootInstance()` Determines if this instance is a root process instance.
`void`	`setCallerId(long callerId)`
`void`	`setCallerType(SFlowNodeType callerType)`
`void`	`setContainerId(long containerId)`
`void`	`setDescription(String description)`
`void`	`setEndDate(long endDate)`
`void`	`setId(long id)`
`void`	`setInterruptingEventId(long interruptingEventId)`
`void`	`setLastUpdate(long lastUpdate)`
`void`	`setRootProcessInstanceId(long rootProcessInstanceId)`
`void`	`setStartDate(long startDate)`
`void`	`setStartedBy(long startedBy)`
`void`	`setStartedBySubstitute(long startedBySubstitute)`
`void`	`setStateCategory(SStateCategory processStateCategory)`
`void`	`setStateId(int stateId)`
`void`	`setStringIndex1(String stringIndex1)`
`void`	`setStringIndex2(String stringIndex2)`
`void`	`setStringIndex3(String stringIndex3)`
`void`	`setStringIndex4(String stringIndex4)`
`void`	`setStringIndex5(String stringIndex5)`
`String`	`toString()`

Methods inherited from class org.bonitasoft.engine.core.process.instance.model.impl.SNamedElementImpl
getName, setName

Methods inherited from class org.bonitasoft.engine.core.process.instance.model.impl.SPersistenceObjectImpl
getId, getTenantId, setTenantId

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

Methods inherited from interface org.bonitasoft.engine.core.process.instance.model.SNamedElement
getName, setName

Methods inherited from interface org.bonitasoft.engine.persistence.PersistentObject
getId, setTenantId

- Constructor Detail
  - SProcessInstanceImpl
```
public SProcessInstanceImpl()
```
  - SProcessInstanceImpl
```
public SProcessInstanceImpl(String name,
                            long processDefinitionId)
```
  - SProcessInstanceImpl
```
public SProcessInstanceImpl(SProcessDefinition definition)
```
- Method Detail
  - setId
```
public void setId(long id)
```
    Specified by:
    
    setId in interface PersistentObject
    
    Overrides:
    
    setId in class SPersistenceObjectImpl
  - getDiscriminator
```
public String getDiscriminator()
```
    Specified by:
    
    getDiscriminator in interface PersistentObject
  - getProcessDefinitionId
```
public long getProcessDefinitionId()
```
    Specified by:
    
    getProcessDefinitionId in interface SProcessInstance
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface SProcessInstance
  - setDescription
```
public void setDescription(String description)
```
  - getStateId
```
public int getStateId()
```
    Specified by:
    
    getStateId in interface SProcessInstance
  - setStateId
```
public void setStateId(int stateId)
```
  - getStartDate
```
public long getStartDate()
```
    Specified by:
    
    getStartDate in interface SProcessInstance
  - setStartDate
```
public void setStartDate(long startDate)
```
  - getStartedBy
```
public long getStartedBy()
```
    Specified by:
    
    getStartedBy in interface SProcessInstance
    
    Returns:
    
    id of the user who originally started the process
  - setStartedBy
```
public void setStartedBy(long startedBy)
```
  - getStartedBySubstitute
```
public long getStartedBySubstitute()
```
    Specified by:
    
    getStartedBySubstitute in interface SProcessInstance
    
    Returns:
    
    id of the user (delegate) who started the process for the original starter
  - setStartedBySubstitute
```
public void setStartedBySubstitute(long startedBySubstitute)
```
  - getEndDate
```
public long getEndDate()
```
    Specified by:
    
    getEndDate in interface SProcessInstance
  - setEndDate
```
public void setEndDate(long endDate)
```
  - getLastUpdate
```
public long getLastUpdate()
```
    Specified by:
    
    getLastUpdate in interface SProcessInstance
  - setLastUpdate
```
public void setLastUpdate(long lastUpdate)
```
  - getContainerId
```
public long getContainerId()
```
    Specified by:
    
    getContainerId in interface SProcessInstance
  - setContainerId
```
public void setContainerId(long containerId)
```
  - getRootProcessInstanceId
```
public long getRootProcessInstanceId()
```
    Specified by:
    
    getRootProcessInstanceId in interface SProcessInstance
  - setRootProcessInstanceId
```
public void setRootProcessInstanceId(long rootProcessInstanceId)
```
  - getCallerId
```
public long getCallerId()
```
    Description copied from interface: SProcessInstance
    
    Get the id of the call activity that started the process instance.
    
    Specified by:
    
    getCallerId in interface SProcessInstance
    
    Returns:
    
    id of the call activity that started the process instance or -1 if the process instance was not started by a call activity
  - setCallerId
```
public void setCallerId(long callerId)
```
  - getCallerType
```
public SFlowNodeType getCallerType()
```
    Description copied from interface: SProcessInstance
    
    Get the caller's SFlowNodeType.
    
    Specified by:
    
    getCallerType in interface SProcessInstance
    
    Returns:
    
    the caller's SFlowNodeType if the it's called by a call activity or sub-process, null otherwise
  - setCallerType
```
public void setCallerType(SFlowNodeType callerType)
```
  - getInterruptingEventId
```
public long getInterruptingEventId()
```
    Description copied from interface: SProcessInstance
    
    Get the id of the end error event that interrupted the process instance.
    
    Specified by:
    
    getInterruptingEventId in interface SProcessInstance
    
    Returns:
    
    the id of the end error event that interrupted the process instance or -1 if the process was not interrupted by a end error event
  - setInterruptingEventId
```
public void setInterruptingEventId(long interruptingEventId)
```
  - getStateCategory
```
public SStateCategory getStateCategory()
```
    Specified by:
    
    getStateCategory in interface SProcessInstance
  - setStateCategory
```
public void setStateCategory(SStateCategory processStateCategory)
```
  - getContainerType
```
public SFlowElementsContainerType getContainerType()
```
    Specified by:
    
    getContainerType in interface SFlowElementsContainer
  - getStringIndex1
```
public String getStringIndex1()
```
    Specified by:
    
    getStringIndex1 in interface SProcessInstance
  - setStringIndex1
```
public void setStringIndex1(String stringIndex1)
```
  - getStringIndex2
```
public String getStringIndex2()
```
    Specified by:
    
    getStringIndex2 in interface SProcessInstance
  - setStringIndex2
```
public void setStringIndex2(String stringIndex2)
```
  - getStringIndex3
```
public String getStringIndex3()
```
    Specified by:
    
    getStringIndex3 in interface SProcessInstance
  - setStringIndex3
```
public void setStringIndex3(String stringIndex3)
```
  - getStringIndex4
```
public String getStringIndex4()
```
    Specified by:
    
    getStringIndex4 in interface SProcessInstance
  - setStringIndex4
```
public void setStringIndex4(String stringIndex4)
```
  - getStringIndex5
```
public String getStringIndex5()
```
    Specified by:
    
    getStringIndex5 in interface SProcessInstance
  - setStringIndex5
```
public void setStringIndex5(String stringIndex5)
```
  - hasBeenInterruptedByEvent
```
public boolean hasBeenInterruptedByEvent()
```
    Specified by:
    
    hasBeenInterruptedByEvent in interface SProcessInstance
  - isRootInstance
```
public boolean isRootInstance()
```
    Description copied from interface: SProcessInstance
    
    Determines if this instance is a root process instance. That is, it is neither a process called by a call activity, neither a sub-process
    
    Specified by:
    
    isRootInstance in interface SProcessInstance
    
    Returns:
    
    true if it's a root process instance; false otherwise.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class SNamedElementImpl
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SNamedElementImpl
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SProcessInstanceImpl

Constructor Summary

Method Summary

Methods inherited from class org.bonitasoft.engine.core.process.instance.model.impl.SNamedElementImpl

Methods inherited from class org.bonitasoft.engine.core.process.instance.model.impl.SPersistenceObjectImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.bonitasoft.engine.core.process.instance.model.SNamedElement

Methods inherited from interface org.bonitasoft.engine.persistence.PersistentObject

Constructor Detail

SProcessInstanceImpl

SProcessInstanceImpl

SProcessInstanceImpl

Method Detail

setId

getDiscriminator

getProcessDefinitionId

getDescription

setDescription

getStateId

setStateId

getStartDate

setStartDate

getStartedBy

setStartedBy

getStartedBySubstitute

setStartedBySubstitute

getEndDate

setEndDate

getLastUpdate

setLastUpdate

getContainerId

setContainerId

getRootProcessInstanceId

setRootProcessInstanceId

getCallerId

setCallerId

getCallerType

setCallerType

getInterruptingEventId

setInterruptingEventId

getStateCategory

setStateCategory

getContainerType

getStringIndex1

setStringIndex1

getStringIndex2

setStringIndex2

getStringIndex3

setStringIndex3

getStringIndex4

setStringIndex4

getStringIndex5

setStringIndex5

hasBeenInterruptedByEvent

isRootInstance

equals

hashCode

toString