Interface KogitoWorkflowProcessInstance
- All Superinterfaces:
org.kie.api.runtime.process.EventListener,KogitoEventListener,KogitoNodeInstanceContainer,KogitoProcessInstance,org.kie.api.runtime.process.NodeInstanceContainer,org.kie.api.runtime.process.ProcessInstance,org.kie.api.runtime.process.WorkflowProcessInstance
public interface KogitoWorkflowProcessInstance
extends org.kie.api.runtime.process.WorkflowProcessInstance, KogitoProcessInstance, KogitoNodeInstanceContainer
-
Field Summary
Fields inherited from interface org.kie.kogito.internal.process.runtime.KogitoProcessInstance
SLA_ABORTED, SLA_MET, SLA_NA, SLA_PENDING, SLA_VIOLATED, STATE_ABORTED, STATE_ACTIVE, STATE_COMPLETED, STATE_ERROR, STATE_PENDING, STATE_SUSPENDEDFields inherited from interface org.kie.api.runtime.process.ProcessInstance
SLA_ABORTED, SLA_MET, SLA_NA, SLA_PENDING, SLA_VIOLATED, STATE_ABORTED, STATE_ACTIVE, STATE_COMPLETED, STATE_PENDING, STATE_SUSPENDED -
Method Summary
Modifier and TypeMethodDescriptionReturns optional correlation key assigned to process instanceReturns end date (either completed or aborted) of this process instanceReturns the throwable originating the error, if availableReturns error message associated with this process instance in case it is in an error state.Returns node definition id associated with node instance that failed in case this process instance is in an errorReturns start date of this process instanceReturns the list of Milestones and their status in the current process instancesMethods 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.kogito.internal.process.runtime.KogitoNodeInstanceContainer
getKogitoNodeInstances, getKogitoNodeInstances, getNodeInstanceMethods inherited from interface org.kie.kogito.internal.process.runtime.KogitoProcessInstance
getBusinessKey, getDescription, getHeaders, getReferenceId, getRootProcessId, getRootProcessInstanceId, getStringId, getVariables, unwrap, wrapMethods inherited from interface org.kie.api.runtime.process.NodeInstanceContainer
getNodeInstance, getNodeInstances, getSerializableNodeInstancesMethods inherited from interface org.kie.api.runtime.process.ProcessInstance
getId, getParentProcessInstanceId, getProcess, getProcessId, getProcessName, getProcessVersion, getStateMethods inherited from interface org.kie.api.runtime.process.WorkflowProcessInstance
getVariable, setVariable
-
Method Details
-
getStartDate
Date getStartDate()Returns start date of this process instance- Specified by:
getStartDatein interfaceKogitoProcessInstance- Returns:
- actual start date
-
getEndDate
Date getEndDate()Returns end date (either completed or aborted) of this process instance- Returns:
- actual end date
-
getNodeIdInError
String getNodeIdInError()Returns node definition id associated with node instance that failed in case this process instance is in an error- Returns:
- node definition id of the failed node instance
-
getNodeInstanceIdInError
String getNodeInstanceIdInError() -
getErrorMessage
String getErrorMessage()Returns error message associated with this process instance in case it is in an error state. It will consists of- fully qualified class name of the root cause
- error message of the root cause
- Returns:
- error message
-
getErrorCause
Returns the throwable originating the error, if available- Returns:
-
getCorrelationKey
String getCorrelationKey()Returns optional correlation key assigned to process instance- Returns:
- correlation key if present otherwise null
-
milestones
Collection<Milestone> milestones()Returns the list of Milestones and their status in the current process instances- Returns:
- Milestones defined in the process
-
adHocFragments
Collection<AdHocFragment> adHocFragments()- Returns:
- AdHocFragments from the process instances
-
getSlaDueDate
Date getSlaDueDate()
-