Package org.activiti.api.process.runtime
Interface ProcessRuntime
public interface ProcessRuntime
-
Method Summary
Modifier and TypeMethodDescriptionReturns the current configuration of the ProcessRuntime, this includes - process runtime events listeners - variable events listenerscreate(CreateProcessInstancePayload startProcessPayload) Create a new Process Instance based on the payload parametersdelete(DeleteProcessPayload deleteProcessPayload) Delete a Process InstanceprocessDefinition(String processDefinitionId) Get process definition by key or id (where the ID is autogenerated at deployment time)processDefinitionMeta(String processDefinitionKey) processDefinitions(Pageable pageable) Get all process definitions by pagesprocessDefinitions(Pageable pageable, List<String> include) Get all process definitions by pages with include parameterprocessDefinitions(Pageable pageable, GetProcessDefinitionsPayload getProcessDefinitionsPayload) Get all process definitions by pages using payload filtersprocessDefinitions(Pageable pageable, GetProcessDefinitionsPayload getProcessDefinitionsPayload, List<String> include) Get all process definitions by pages using payload filters and include parameterprocessInstance(String processInstanceId) Get Process Instance by idprocessInstanceMeta(String processInstanceId) processInstances(Pageable pageable) Get all process instances by pages - Notice that only in-flight or suspended processes will be returned here - For already completed process instance check at the query serviceprocessInstances(Pageable pageable, GetProcessInstancesPayload getProcessInstancesPayload) Get all process instances by pages filtering by - Notice that only in-flight or suspended processes will be returned here - For already completed process instance check at the query servicevoidreceive(ReceiveMessagePayload messagePayload) voidremoveVariables(RemoveProcessVariablesPayload removeProcessVariablesPayload) resume(ResumeProcessPayload resumeProcessPayload) Resume a suspended process instancevoidsetVariables(SetProcessVariablesPayload setProcessVariablesPayload) voidsignal(SignalPayload signalPayload) start(StartMessagePayload messagePayload) start(StartProcessPayload startProcessPayload) Start a new Process Instance based on the payload parametersstartCreatedProcess(String processInstanceId, StartProcessPayload startProcessPayload) Start an already created Process Instance based on the process instance idsuspend(SuspendProcessPayload suspendProcessPayload) Suspend a process instanceupdate(UpdateProcessPayload updateProcessPayload) Update a Process Instancevariables(GetVariablesPayload getVariablesPayload)
-
Method Details
-
configuration
ProcessRuntimeConfiguration configuration()Returns the current configuration of the ProcessRuntime, this includes - process runtime events listeners - variable events listeners -
processDefinition
Get process definition by key or id (where the ID is autogenerated at deployment time) -
start
Start a new Process Instance based on the payload parameters -
startCreatedProcess
ProcessInstance startCreatedProcess(String processInstanceId, StartProcessPayload startProcessPayload) Start an already created Process Instance based on the process instance id -
create
Create a new Process Instance based on the payload parameters -
processInstance
Get Process Instance by id -
suspend
Suspend a process instance -
resume
Resume a suspended process instance -
delete
Delete a Process Instance -
update
Update a Process Instance -
signal
-
processDefinitionMeta
-
processInstanceMeta
-
variables
-
removeVariables
-
setVariables
-
receive
-
start
-
selectLatestDeployment
Deployment selectLatestDeployment()
-