Package org.activiti.api.process.runtime

Interface ProcessAdminRuntime

public interface ProcessAdminRuntime

Method Summary

Modifier and Type	Method	Description
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)
Page<ProcessDefinition>	processDefinitions(Pageable pageable)	Get all process definitions by pages
Page<ProcessDefinition>	processDefinitions(Pageable pageable, GetProcessDefinitionsPayload getProcessDefinitionsPayload)	Get all process definitions by pages using payload filters
ProcessInstance	processInstance(String processInstanceId)	Get Process Instance by id
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
void	setVariables(SetProcessVariablesPayload setProcessVariablesPayload)
void	signal(SignalPayload signalPayload)	Signal
ProcessInstance	start(StartMessagePayload messagePayload)
ProcessInstance	start(StartProcessPayload startProcessPayload)	Start a new Process Instance based on the payload parameters
ProcessInstance	suspend(SuspendProcessPayload suspendProcessPayload)	Suspend a process instance
ProcessInstance	update(UpdateProcessPayload updateProcessPayload)	Update a Process Instance
List<VariableInstance>	variables(GetVariablesPayload getVariablesPayload)

Method Details

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,
 GetProcessDefinitionsPayload getProcessDefinitionsPayload)

Get all process definitions by pages using payload filters

start

ProcessInstance start(StartProcessPayload startProcessPayload)

Start 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

delete

ProcessInstance delete(DeleteProcessPayload deleteProcessPayload)

Delete a Process Instance

signal

void signal(SignalPayload signalPayload)

Signal

suspend

ProcessInstance suspend(SuspendProcessPayload suspendProcessPayload)

Suspend a process instance

resume

ProcessInstance resume(ResumeProcessPayload resumeProcessPayload)

Resume a suspended process instance

update

ProcessInstance update(UpdateProcessPayload updateProcessPayload)

Update a Process Instance

setVariables

void setVariables(SetProcessVariablesPayload setProcessVariablesPayload)

removeVariables

void removeVariables(RemoveProcessVariablesPayload removeProcessVariablesPayload)

variables

List<VariableInstance> variables(GetVariablesPayload getVariablesPayload)

receive

void receive(ReceiveMessagePayload messagePayload)

start

ProcessInstance start(StartMessagePayload messagePayload)