Package org.activiti.api.process.runtime

Interface ProcessRuntime

public interface ProcessRuntime

Method Summary

Modifier and Type	Method	Description
ProcessRuntimeConfiguration	configuration()	Returns the current configuration of the ProcessRuntime, this includes - process runtime events listeners - variable events listeners
ProcessInstance	create(CreateProcessInstancePayload startProcessPayload)	Create a new Process Instance based on the payload parameters
ProcessInstance	delete(DeleteProcessPayload deleteProcessPayload)	Delete a Process Instance
ProcessDefinition	processDefinition(String processDefinitionId)	Get process definition by key or id (where the ID is autogenerated at deployment time)
ProcessDefinitionMeta	processDefinitionMeta(String processDefinitionKey)
Page<ProcessDefinition>	processDefinitions(Pageable pageable)	Get all process definitions by pages
Page<ProcessDefinition>	processDefinitions(Pageable pageable, List<String> include)	Get all process definitions by pages with include parameter
Page<ProcessDefinition>	processDefinitions(Pageable pageable, GetProcessDefinitionsPayload getProcessDefinitionsPayload)	Get all process definitions by pages using payload filters
Page<ProcessDefinition>	processDefinitions(Pageable pageable, GetProcessDefinitionsPayload getProcessDefinitionsPayload, List<String> include)	Get all process definitions by pages using payload filters and include parameter
ProcessInstance	processInstance(String processInstanceId)	Get Process Instance by id
ProcessInstanceMeta	processInstanceMeta(String processInstanceId)
Page<ProcessInstance>	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 service
Page<ProcessInstance>	processInstances(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 service
void	receive(ReceiveMessagePayload messagePayload)
void	removeVariables(RemoveProcessVariablesPayload removeProcessVariablesPayload)
ProcessInstance	resume(ResumeProcessPayload resumeProcessPayload)	Resume a suspended process instance
Deployment	selectLatestDeployment()
void	setVariables(SetProcessVariablesPayload setProcessVariablesPayload)
void	signal(SignalPayload signalPayload)
ProcessInstance	start(StartMessagePayload messagePayload)
ProcessInstance	start(StartProcessPayload startProcessPayload)	Start a new Process Instance based on the payload parameters
ProcessInstance	startCreatedProcess(String processInstanceId, StartProcessPayload startProcessPayload)	Start an already created Process Instance based on the process instance id
ProcessInstance	suspend(SuspendProcessPayload suspendProcessPayload)	Suspend a process instance
ProcessInstance	update(UpdateProcessPayload updateProcessPayload)	Update a Process Instance
List<VariableInstance>	variables(GetVariablesPayload getVariablesPayload)

Method Details

configuration

ProcessRuntimeConfiguration configuration()

Returns the current configuration of the ProcessRuntime, this includes - process runtime events listeners - variable events listeners

processDefinition

ProcessDefinition processDefinition(String processDefinitionId)

Get process definition by key or id (where the ID is autogenerated at deployment time)

processDefinitions

Page<ProcessDefinition> processDefinitions(Pageable pageable)

Get all process definitions by pages

processDefinitions

Page<ProcessDefinition> processDefinitions(Pageable pageable,
 List<String> include)

Get all process definitions by pages with include parameter

processDefinitions

Page<ProcessDefinition> processDefinitions(Pageable pageable,
 GetProcessDefinitionsPayload getProcessDefinitionsPayload)

Get all process definitions by pages using payload filters

processDefinitions

Page<ProcessDefinition> processDefinitions(Pageable pageable,
 GetProcessDefinitionsPayload getProcessDefinitionsPayload,
 List<String> include)

Get all process definitions by pages using payload filters and include parameter

start

ProcessInstance start(StartProcessPayload startProcessPayload)

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

ProcessInstance create(CreateProcessInstancePayload startProcessPayload)

Create a new Process Instance based on the payload parameters

processInstances

Page<ProcessInstance> 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 service

processInstances

Page<ProcessInstance> processInstances(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 service

processInstance

ProcessInstance processInstance(String processInstanceId)

Get Process Instance by id

suspend

ProcessInstance suspend(SuspendProcessPayload suspendProcessPayload)

Suspend a process instance

resume

ProcessInstance resume(ResumeProcessPayload resumeProcessPayload)

Resume a suspended process instance

delete

ProcessInstance delete(DeleteProcessPayload deleteProcessPayload)

Delete a Process Instance

update

ProcessInstance update(UpdateProcessPayload updateProcessPayload)

Update a Process Instance

signal

void signal(SignalPayload signalPayload)

processDefinitionMeta

ProcessDefinitionMeta processDefinitionMeta(String processDefinitionKey)

processInstanceMeta

ProcessInstanceMeta processInstanceMeta(String processInstanceId)

variables

List<VariableInstance> variables(GetVariablesPayload getVariablesPayload)

removeVariables

void removeVariables(RemoveProcessVariablesPayload removeProcessVariablesPayload)

setVariables

void setVariables(SetProcessVariablesPayload setProcessVariablesPayload)

receive

void receive(ReceiveMessagePayload messagePayload)

start

ProcessInstance start(StartMessagePayload messagePayload)

selectLatestDeployment

Deployment selectLatestDeployment()