Interface ProcessInstanceResult
- All Known Implementing Classes:
CreateProcessInstanceWithResultResponseImpl
public interface ProcessInstanceResult
-
Method Summary
Modifier and TypeMethodDescriptionBPMN process id of the process which this instance was created forlong
Key of the process which this instance was created forlong
Unique key of the created process instance on the partitionTenant identifier that owns this process instancegetVariable
(String name) Variable returned by name after the process is completed.Variables returned after the process is completed.Variables returned after the process is completed.<T> T
getVariablesAsType
(Class<T> variableType) Variables returned after the process is completed.int
Version of the process which this instance was created for
-
Method Details
-
getProcessDefinitionKey
long getProcessDefinitionKey()Key of the process which this instance was created for -
getBpmnProcessId
String getBpmnProcessId()BPMN process id of the process which this instance was created for -
getVersion
int getVersion()Version of the process which this instance was created for -
getProcessInstanceKey
long getProcessInstanceKey()Unique key of the created process instance on the partition -
getVariables
String getVariables()Variables returned after the process is completed.- Returns:
- JSON-formatted variables
-
getVariablesAsMap
Variables returned after the process is completed.- Returns:
- de-serialized variables as map
-
getVariablesAsType
Variables returned after the process is completed.- Returns:
- de-serialized variables as the given type
-
getVariable
Variable returned by name after the process is completed.- Parameters:
name
- the name of the variable- Returns:
- de-serialized variable value or null if the provided variable name is present among the
available variables, otherwise throw a
ClientException
-
getTenantId
Tenant identifier that owns this process instance
-