Interface KogitoProcessInstance
- All Superinterfaces:
org.kie.api.runtime.process.EventListener,KogitoEventListener,org.kie.api.runtime.process.ProcessInstance
- All Known Subinterfaces:
KogitoWorkflowProcessInstance
public interface KogitoProcessInstance
extends org.kie.api.runtime.process.ProcessInstance, KogitoEventListener
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final int -
Method Summary
Modifier and TypeMethodDescriptionReturns optional business key of the process instanceThe description of the current process instanceReturns optional header of the process instanceReturns optional reference id this process instance was triggered byThe id of the root process definition that is related to this process instance.Returns root process instance id if this process instance has a root process instanceReturns current snapshot of process instance variablesunwrap()voidwrap(ProcessInstance<?> kogitoProcessInstance) Methods inherited from interface org.kie.api.runtime.process.EventListener
getEventTypes, signalEventMethods inherited from interface org.kie.kogito.internal.process.event.KogitoEventListener
getEventDescriptions, getEventTypes, signalEventMethods inherited from interface org.kie.api.runtime.process.ProcessInstance
getId, getParentProcessInstanceId, getProcess, getProcessId, getProcessName, getProcessVersion, getState
-
Field Details
-
STATE_PENDING
static final int STATE_PENDING- See Also:
-
STATE_ACTIVE
static final int STATE_ACTIVE- See Also:
-
STATE_COMPLETED
static final int STATE_COMPLETED- See Also:
-
STATE_ABORTED
static final int STATE_ABORTED- See Also:
-
STATE_SUSPENDED
static final int STATE_SUSPENDED- See Also:
-
STATE_ERROR
static final int STATE_ERROR- See Also:
-
SLA_NA
static final int SLA_NA- See Also:
-
SLA_PENDING
static final int SLA_PENDING- See Also:
-
SLA_MET
static final int SLA_MET- See Also:
-
SLA_VIOLATED
static final int SLA_VIOLATED- See Also:
-
SLA_ABORTED
static final int SLA_ABORTED- See Also:
-
-
Method Details
-
getStringId
String getStringId() -
getRootProcessInstanceId
String getRootProcessInstanceId()Returns root process instance id if this process instance has a root process instance- Returns:
- the unique id of root process instance, null if this process instance doesn't have a root or is a root itself
-
getRootProcessId
String getRootProcessId()The id of the root process definition that is related to this process instance.- Returns:
- the id of the root process definition that is related to this process instance
-
getVariables
Returns current snapshot of process instance variables- Returns:
- non empty map of process instance variables
-
getReferenceId
String getReferenceId()Returns optional reference id this process instance was triggered by- Returns:
- reference id or null if not set
-
getDescription
String getDescription()The description of the current process instance- Returns:
- the process instance description
-
getBusinessKey
String getBusinessKey()Returns optional business key of the process instance- Returns:
- the business key or null if not set
-
getStartDate
Date getStartDate() -
getHeaders
Returns optional header of the process instance- Returns:
- map with headers
-
wrap
-
unwrap
ProcessInstance<?> unwrap()
-