Package io.camunda.zeebe.engine.state.instance

Class ElementInstance

java.lang.Object

io.camunda.zeebe.msgpack.value.BaseValue

io.camunda.zeebe.msgpack.value.ObjectValue

io.camunda.zeebe.msgpack.UnpackedObject

io.camunda.zeebe.engine.state.instance.ElementInstance

All Implemented Interfaces:

DbValue, Recyclable, BufferReader, BufferWriter

public final class ElementInstance
extends UnpackedObject
implements DbValue

Field Summary

Fields inherited from class io.camunda.zeebe.msgpack.UnpackedObject

reader, writer

Constructor Summary

Constructors

Constructor	Description
ElementInstance()
ElementInstance(long key, ElementInstance parent, ProcessInstanceIntent state, ProcessInstanceRecord value)
ElementInstance(long key, ProcessInstanceIntent state, ProcessInstanceRecord value)

Method Summary

Modifier and Type	Method	Description
void	addActiveSequenceFlowId(org.agrona.DirectBuffer sequenceFlowId)
boolean	canTerminate()
void	clearInterruptedState()
void	decrementActiveSequenceFlows()
void	decrementChildCount()
List<org.agrona.DirectBuffer>	getActiveSequenceFlowIds()	Returns a list of currently active sequence flow ids.
long	getActiveSequenceFlows()
long	getCalledChildInstanceKey()
int	getExecutionListenerIndex()
org.agrona.DirectBuffer	getInterruptingElementId()
long	getJobKey()
long	getKey()
int	getMultiInstanceLoopCounter()
int	getNumberOfActiveElementInstances()
int	getNumberOfCompletedElementInstances()
int	getNumberOfElementInstances()
int	getNumberOfTerminatedElementInstances()
long	getParentKey()
ProcessInstanceIntent	getState()
long	getUserTaskKey()
ProcessInstanceRecord	getValue()
void	incrementActiveSequenceFlows()
void	incrementExecutionListenerIndex()
void	incrementMultiInstanceLoopCounter()
void	incrementNumberOfCompletedElementInstances()
void	incrementNumberOfElementInstances()
void	incrementNumberOfTerminatedElementInstances()
boolean	isActive()
boolean	isInFinalState()
boolean	isInterrupted()
boolean	isTerminating()
void	removeActiveSequenceFlowId(org.agrona.DirectBuffer sequenceFlowId)
void	resetActiveSequenceFlows()
void	resetExecutionListenerIndex()
void	setCalledChildInstanceKey(long calledChildInstanceKey)
void	setInterruptingElementId(org.agrona.DirectBuffer elementId)
void	setJobKey(long jobKey)
void	setMultiInstanceLoopCounter(int loopCounter)
void	setState(ProcessInstanceIntent state)
void	setUserTaskKey(long userTaskKey)
void	setValue(ProcessInstanceRecord value)

Methods inherited from class io.camunda.zeebe.msgpack.UnpackedObject

getLength, wrap, wrap, write

Methods inherited from class io.camunda.zeebe.msgpack.value.ObjectValue

declareProperty, equals, getEncodedLength, hashCode, isEmpty, read, reset, write, writeJSON

Methods inherited from class io.camunda.zeebe.msgpack.value.BaseValue

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.camunda.zeebe.util.buffer.BufferReader

copyFrom, wrap

Methods inherited from interface io.camunda.zeebe.util.buffer.BufferWriter

getLength, write

Methods inherited from interface io.camunda.zeebe.msgpack.Recyclable

reset

Constructor Details

ElementInstance

public ElementInstance()

ElementInstance

public ElementInstance(long key,
 ElementInstance parent,
 ProcessInstanceIntent state,
 ProcessInstanceRecord value)

ElementInstance

public ElementInstance(long key,
 ProcessInstanceIntent state,
 ProcessInstanceRecord value)

Method Details

getKey

public long getKey()

getState

public ProcessInstanceIntent getState()

setState

public void setState(ProcessInstanceIntent state)

getValue

public ProcessInstanceRecord getValue()

setValue

public void setValue(ProcessInstanceRecord value)

getJobKey

public long getJobKey()

setJobKey

public void setJobKey(long jobKey)

decrementChildCount

public void decrementChildCount()

canTerminate

public boolean canTerminate()

isActive

public boolean isActive()

isTerminating

public boolean isTerminating()

isInFinalState

public boolean isInFinalState()

getNumberOfActiveElementInstances

public int getNumberOfActiveElementInstances()

getNumberOfCompletedElementInstances

public int getNumberOfCompletedElementInstances()

getNumberOfElementInstances

public int getNumberOfElementInstances()

getNumberOfTerminatedElementInstances

public int getNumberOfTerminatedElementInstances()

incrementNumberOfCompletedElementInstances

public void incrementNumberOfCompletedElementInstances()

incrementNumberOfElementInstances

public void incrementNumberOfElementInstances()

incrementNumberOfTerminatedElementInstances

public void incrementNumberOfTerminatedElementInstances()

getMultiInstanceLoopCounter

public int getMultiInstanceLoopCounter()

setMultiInstanceLoopCounter

public void setMultiInstanceLoopCounter(int loopCounter)

incrementMultiInstanceLoopCounter

public void incrementMultiInstanceLoopCounter()

getCalledChildInstanceKey

public long getCalledChildInstanceKey()

setCalledChildInstanceKey

public void setCalledChildInstanceKey(long calledChildInstanceKey)

getInterruptingElementId

public org.agrona.DirectBuffer getInterruptingElementId()

setInterruptingElementId

public void setInterruptingElementId(org.agrona.DirectBuffer elementId)

isInterrupted

public boolean isInterrupted()

clearInterruptedState

public void clearInterruptedState()

getParentKey

public long getParentKey()

getActiveSequenceFlows

public long getActiveSequenceFlows()

decrementActiveSequenceFlows

public void decrementActiveSequenceFlows()

incrementActiveSequenceFlows

public void incrementActiveSequenceFlows()

addActiveSequenceFlowId

public void addActiveSequenceFlowId(org.agrona.DirectBuffer sequenceFlowId)

removeActiveSequenceFlowId

public void removeActiveSequenceFlowId(org.agrona.DirectBuffer sequenceFlowId)

resetActiveSequenceFlows

public void resetActiveSequenceFlows()

getUserTaskKey

public long getUserTaskKey()

setUserTaskKey

public void setUserTaskKey(long userTaskKey)

getExecutionListenerIndex

public int getExecutionListenerIndex()

incrementExecutionListenerIndex

public void incrementExecutionListenerIndex()

resetExecutionListenerIndex

public void resetExecutionListenerIndex()

getActiveSequenceFlowIds

public List<org.agrona.DirectBuffer> getActiveSequenceFlowIds()

Returns a list of currently active sequence flow ids. If the same sequence flow is active multiple times, it will appear in the list multiple times. I.e. this can be used to track virtual sequence flow instances. Virtual, because there are no sequence flow instances in Zeebe.

Warning, this method should not be used for process instances created before 8.6. It may provide incorrect information for such process instances.

Since:

8.6