org.flowable.cdi

Class BusinessProcess

java.lang.Object

org.flowable.cdi.BusinessProcess

All Implemented Interfaces:

Serializable

@Named
public class BusinessProcess
extends Object
implements Serializable

Bean supporting contextual business process management. This allows us to implement a unit of work, in which a particular CDI scope (Conversation / Request / Thread) is associated with a particular Execution / ProcessInstance or Task.

The protocol is that we associate the BusinessProcess bean with a particular Execution / Task, then perform some changes (retrieve / set process variables) and then end the unit of work. This bean makes sure that our changes are only "flushed" to the process engine when we successfully complete the unit of work.

A typical usage scenario might look like this:
1st unit of work ("process instantiation"):

 conversation.begin();
 ...
 businessProcess.setVariable("billingId", "1"); // setting variables before starting the process
 businessProcess.startProcessByKey("billingProcess");
 conversation.end();
 

2nd unit of work ("perform a user task"):

 conversation.begin();
 businessProcess.startTask(id); // now we have associated a task with the current conversation
 ...                            // this allows us to retrieve and change process variables
                                // and @BusinessProcessScoped beans
 businessProcess.setVariable("billingDetails", "someValue"); // these changes are cached in the conversation
 ...
 businessProcess.completeTask(); // now all changed process variables are flushed
 conversation.end();
 

NOTE: in the absence of a conversation, (non faces request, i.e. when processing a JAX-RS, JAX-WS, JMS, remote EJB or plain Servlet requests), the BusinessProcess bean associates with the current Request (see @RequestScoped).

NOTE: in the absence of a request, ie. when the JobExecutor accesses @BusinessProcessScoped beans, the execution is associated with the current thread.

Author:

Daniel Meyer, Falko Menge

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BusinessProcess()

Method Summary

Modifier and Type	Method and Description
protected void	assertAssociated()
protected void	assertTaskAssociated()
void	associateExecutionById(String executionId) Associate with the provided execution.
void	completeTask() Completes the current UserTask, see TaskService.complete(String)
void	completeTask(boolean endConversation)
protected Map<String,Object>	getAndClearCachedVariables()
protected Map<String,Object>	getCachedVariables()
Execution	getExecution() Returns the currently associated execution or 'null'
String	getExecutionId()
ProcessInstance	getProcessInstance() Returns the ProcessInstance currently associated or 'null'
String	getProcessInstanceId() Returns the id of the currently associated process instance or 'null'
Task	getTask() Returns the currently associated Task or 'null'
String	getTaskId() Returns the id of the task associated with the current conversation or 'null'.
<T> T	getVariable(String variableName)
boolean	isAssociated() returns true if an Execution is associated.
boolean	isTaskAssociated()
void	setExecution(Execution execution)
protected void	setExecutionId(String executionId)
void	setTask(Task task)
void	setTaskId(String taskId)
void	setVariable(String variableName, Object value) Set a value for a process variable.
ProcessInstance	startProcessById(String processDefinitionId)
ProcessInstance	startProcessById(String processDefinitionId, Map<String,Object> variables)
ProcessInstance	startProcessById(String processDefinitionId, String businessKey)
ProcessInstance	startProcessById(String processDefinitionId, String businessKey, Map<String,Object> variables)
ProcessInstance	startProcessByKey(String key)
ProcessInstance	startProcessByKey(String key, Map<String,Object> variables)
ProcessInstance	startProcessByKey(String key, String businessKey)
ProcessInstance	startProcessByKey(String key, String businessKey, Map<String,Object> variables)
ProcessInstance	startProcessByMessage(String messageName)
ProcessInstance	startProcessByMessage(String messageName, Map<String,Object> processVariables)
ProcessInstance	startProcessByMessage(String messageName, String businessKey, Map<String,Object> processVariables)
ProcessInstance	startProcessByName(String string) Deprecated.
ProcessInstance	startProcessByName(String string, Map<String,Object> variables) Deprecated.
Task	startTask(String taskId) Associates the task with the provided taskId with the current conversation.
Task	startTask(String taskId, boolean beginConversation)
void	triggerExecution() Signals the current execution, see RuntimeService.trigger(String)
void	triggerExecution(boolean endConversation)
protected void	validateValidUsage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BusinessProcess

public BusinessProcess()

Method Detail

validateValidUsage

protected void validateValidUsage()

startProcessById

public ProcessInstance startProcessById(String processDefinitionId)

startProcessById

public ProcessInstance startProcessById(String processDefinitionId,
                                        String businessKey)

startProcessById

public ProcessInstance startProcessById(String processDefinitionId,
                                        Map<String,Object> variables)

startProcessById

public ProcessInstance startProcessById(String processDefinitionId,
                                        String businessKey,
                                        Map<String,Object> variables)

startProcessByKey

public ProcessInstance startProcessByKey(String key)

startProcessByKey

public ProcessInstance startProcessByKey(String key,
                                         String businessKey)

startProcessByKey

public ProcessInstance startProcessByKey(String key,
                                         Map<String,Object> variables)

startProcessByKey

public ProcessInstance startProcessByKey(String key,
                                         String businessKey,
                                         Map<String,Object> variables)

startProcessByMessage

public ProcessInstance startProcessByMessage(String messageName)

startProcessByMessage

public ProcessInstance startProcessByMessage(String messageName,
                                             Map<String,Object> processVariables)

startProcessByMessage

public ProcessInstance startProcessByMessage(String messageName,
                                             String businessKey,
                                             Map<String,Object> processVariables)

startProcessByName

@Deprecated
public ProcessInstance startProcessByName(String string)

Deprecated.

startProcessByName

@Deprecated
public ProcessInstance startProcessByName(String string,
                                                      Map<String,Object> variables)

Deprecated.

associateExecutionById

public void associateExecutionById(String executionId)

Associate with the provided execution. This starts a unit of work.

Parameters:

executionId - the id of the execution to associate with.

Throws:

FlowableCdiException - if no such execution exists

isAssociated

public boolean isAssociated()

returns true if an Execution is associated.

See Also:

associateExecutionById(String)

triggerExecution

public void triggerExecution()

Signals the current execution, see RuntimeService.trigger(String)

Ends the current unit of work (flushes changes to process variables set using setVariable(String, Object) or made on @BusinessProcessScoped beans).

Throws:

FlowableCdiException - if no execution is currently associated

FlowableException - if the command fails

triggerExecution

public void triggerExecution(boolean endConversation)

See Also:

In addition, this method allows to end the current conversation

startTask

public Task startTask(String taskId)

Associates the task with the provided taskId with the current conversation.

Parameters:

taskId - the id of the task

Returns:

the resumed task

Throws:

FlowableCdiException - if no such task is found

startTask

public Task startTask(String taskId,
                      boolean beginConversation)

See Also:

this method allows to start a conversation if no conversation is active

completeTask

public void completeTask()

Completes the current UserTask, see TaskService.complete(String)

Ends the current unit of work (flushes changes to process variables set using setVariable(String, Object) or made on @BusinessProcessScoped beans).

Throws:

FlowableCdiException - if no task is currently associated

FlowableException - if the command fails

completeTask

public void completeTask(boolean endConversation)

See Also:

In addition this allows to end the current conversation.

isTaskAssociated

public boolean isTaskAssociated()

getVariable

public <T> T getVariable(String variableName)

Parameters:

variableName - the name of the process variable for which the value is to be retrieved

Returns:

the value of the provided process variable or 'null' if no such variable is set

setVariable

public void setVariable(String variableName,
                        Object value)

Set a value for a process variable.

NOTE: If no execution is currently associated, the value is temporarily cached and flushed to the process instance at the end of the unit of work

Parameters:

variableName - the name of the process variable for which a value is to be set

value - the value to be set

setTask

public void setTask(Task task)

See Also:

startTask(String)

setTaskId

public void setTaskId(String taskId)

See Also:

startTask(String)

setExecution

public void setExecution(Execution execution)

See Also:

associateExecutionById(String)

setExecutionId

protected void setExecutionId(String executionId)

See Also:

associateExecutionById(String)

getProcessInstanceId

public String getProcessInstanceId()

Returns the id of the currently associated process instance or 'null'

getTaskId

public String getTaskId()

Returns the id of the task associated with the current conversation or 'null'.

getTask

public Task getTask()

Returns the currently associated Task or 'null'

Throws:

FlowableCdiException - if no Task is associated. Use isTaskAssociated() to check whether an association exists.

getExecution

public Execution getExecution()

Returns the currently associated execution or 'null'

getExecutionId

public String getExecutionId()

See Also:

getExecution()

getProcessInstance

public ProcessInstance getProcessInstance()

Returns the ProcessInstance currently associated or 'null'

Throws:

FlowableCdiException - if no Execution is associated. Use isAssociated() to check whether an association exists.

assertAssociated

protected void assertAssociated()

assertTaskAssociated

protected void assertTaskAssociated()

getCachedVariables

protected Map<String,Object> getCachedVariables()

getAndClearCachedVariables

protected Map<String,Object> getAndClearCachedVariables()