org.camunda.bpm.engine.runtime

Interface ProcessInstantiationBuilder

All Superinterfaces:

ActivityInstantiationBuilder<ProcessInstantiationBuilder>, InstantiationBuilder<ProcessInstantiationBuilder>

All Known Implementing Classes:

ProcessInstantiationBuilderImpl

public interface ProcessInstantiationBuilder
extends ActivityInstantiationBuilder<ProcessInstantiationBuilder>, InstantiationBuilder<ProcessInstantiationBuilder>

Author:

Thorben Lindhauer

Method Summary

Methods

Modifier and Type	Method and Description
ProcessInstantiationBuilder	businessKey(String businessKey) Set the business key for the process instance
ProcessInstantiationBuilder	caseInstanceId(String caseInstanceId) Associate a case instance with the process instance
ProcessInstance	execute() Start the process instance by executing all instructions in the order they are submitted.
ProcessInstance	execute(boolean skipCustomListeners, boolean skipIoMappings) Start the process instance by executing all instructions in the order they are submitted.

Methods inherited from interface org.camunda.bpm.engine.runtime.ActivityInstantiationBuilder

setVariable, setVariableLocal, setVariables, setVariablesLocal

Methods inherited from interface org.camunda.bpm.engine.runtime.InstantiationBuilder

startAfterActivity, startBeforeActivity, startTransition

Method Detail

businessKey

ProcessInstantiationBuilder businessKey(String businessKey)

Set the business key for the process instance

caseInstanceId

ProcessInstantiationBuilder caseInstanceId(String caseInstanceId)

Associate a case instance with the process instance

execute

ProcessInstance execute()

Start the process instance by executing all instructions in the order they are submitted. Custom execution and task listeners, as well as task input output mappings are executed.

Returns:

the newly created process instance

Throws:

AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

execute

ProcessInstance execute(boolean skipCustomListeners,
                      boolean skipIoMappings)

Start the process instance by executing all instructions in the order they are submitted.

Parameters:

skipCustomListeners - specifies whether custom listeners (task and execution) should be invoked when executing the instructions

skipIoMappings - specifies whether input/output mappings for tasks should be invoked throughout the transaction when executing the instructions

Returns:

the newly created process instance

Throws:

AuthorizationException - if the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION..