org.ow2.bonita.util
Class ProcessBuilder

java.lang.Object
  org.ow2.bonita.util.ProcessBuilder

public final class ProcessBuilder
extends java.lang.Object

A ProcessBuilder constructs a process by adding methods.

Author:

Matthieu Chaffotte, Charles Souillard

Method Summary

ProcessBuilder	addActivityExecutingTime(long executingTime) Adds an executing time (in ms) to the current activity.
ProcessBuilder	addActivityPriority(int priority) Adds a priority to the current activity.
ProcessBuilder	addAttachment(java.lang.String name) Adds an attachment on a process.
ProcessBuilder	addAttachment(java.lang.String name, java.lang.String filePath) Adds an attachment on a process.
ProcessBuilder	addAttachment(java.lang.String name, java.lang.String filePath, java.lang.String fileName) Adds an attachment on a process.
ProcessBuilder	addBooleanData(java.lang.String dataName) Adds a Boolean variable to the current BPM entity.
ProcessBuilder	addBooleanData(java.lang.String dataName, java.lang.Boolean initialValue) Adds a Boolean variable to the current BPM entity with an initial variable.
ProcessBuilder	addBooleanData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Boolean variable to the current BPM entity with an initial variable.
ProcessBuilder	addCharData(java.lang.String dataName) Adds a Character variable to the current BPM entity.
ProcessBuilder	addCharData(java.lang.String dataName, java.lang.Character initialValue) Adds a Character variable to the current BPM entity with an initial variable.
ProcessBuilder	addCharData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Character variable to the current BPM entity.
ProcessBuilder	addCondition(java.lang.String expression) Adds a condition on a transition
ProcessBuilder	addConnector(HookDefinition.Event event, java.lang.String className, boolean throwingException) Adds a connector to an activity or a process.
ProcessBuilder	addDateData(java.lang.String dataName) Adds a Date variable to the current BPM entity.
ProcessBuilder	addDateData(java.lang.String dataName, java.util.Date initialValue) Adds a Date variable to the current BPM entity with an initial variable.
ProcessBuilder	addDateData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Date variable to the current BPM entity with an initial variable.
ProcessBuilder	addDeadline(java.lang.String condition, java.lang.String connectorClassName) Add a deadline to the current activity.
ProcessBuilder	addDecisionNode(java.lang.String taskName) Add a decision node to the ProcessBuilder.
ProcessBuilder	addDescription(java.lang.String description) Adds a description to the current BPM entity.
ProcessBuilder	addDoubleData(java.lang.String dataName) Adds a Double variable to the current BPM entity.
ProcessBuilder	addDoubleData(java.lang.String dataName, java.lang.Double initialValue) Adds a Double variable to the current BPM entity with an initial variable.
ProcessBuilder	addDoubleData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Double variable to the current BPM entity with an initial variable.
ProcessBuilder	addDynamicDescription(java.lang.String dynamicDescription) Adds a dynamic description to the current BPM entity.
ProcessBuilder	addDynamicLabel(java.lang.String dynamicLabel) Adds a dynamic label to the current BPM entity.
ProcessBuilder	addEnumData(java.lang.String dataName, java.util.Set<java.lang.String> enumeariontValues, java.lang.String initialValue) Adds an Enumeration variable to the current BPM entity with an initial variable.
ProcessBuilder	addEnumData(java.lang.String dataName, java.lang.String scriptingValue, java.util.Set<java.lang.String> enumeariontValues) Adds an Enumeration variable to the current BPM entity with an initial variable.
ProcessBuilder	addFilter(java.lang.String className) Add a filter to an activity (A filter is a specific connector)
ProcessBuilder	addFloatData(java.lang.String dataName) Adds a Float variable to the current BPM entity.
ProcessBuilder	addFloatData(java.lang.String dataName, java.lang.Float initialValue) Adds a Float variable to the current BPM entity with an initial variable.
ProcessBuilder	addFloatData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Float variable to the current BPM entity with an initial variable.
ProcessBuilder	addGroup(java.lang.String groupName) Adds a group.
ProcessBuilder	addGroupResolver(java.lang.String groupResolverClassName) Adds a RoleResolver to a group.
ProcessBuilder	addHuman(java.lang.String humanName) Adds a human to a process.
ProcessBuilder	addHumanTask(java.lang.String taskName, java.lang.String... authorityNames) Add a human task.
ProcessBuilder	addInputParameter(java.lang.String fieldName, java.lang.Object... value) Adds an input parameter on the current connector.
ProcessBuilder	addIntegerData(java.lang.String dataName) Adds a Integer variable to the current BPM entity.
ProcessBuilder	addIntegerData(java.lang.String dataName, java.lang.Integer initialValue) Adds an Integer variable to the current BPM entity with an initial variable.
ProcessBuilder	addIntegerData(java.lang.String dataName, java.lang.String scriptingValue) Adds an Integer variable to the current BPM entity with an initial variable.
ProcessBuilder	addJoinType(ActivityDefinition.JoinType join) Defines the join type of an activity.
ProcessBuilder	addLabel(java.lang.String label) Adds a label to the current BPM entity.
ProcessBuilder	addLongData(java.lang.String dataName) Adds a Long variable to the current BPM entity.
ProcessBuilder	addLongData(java.lang.String dataName, java.lang.Long initialValue) Adds a Long variable to the current BPM entity with an initial variable.
ProcessBuilder	addLongData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Long variable to the current BPM entity with an initial variable.
ProcessBuilder	addLoop(java.lang.String condition, boolean beforeExecution)
ProcessBuilder	addLoop(java.lang.String condition, boolean beforeExecution, java.lang.String loopMaximum)
ProcessBuilder	addMultiInstanciation(java.lang.String variableName, java.lang.String className) Deprecated.
ProcessBuilder	addMultipleActivitiesInstantiator(java.lang.String className)
ProcessBuilder	addMultipleActivitiesJoinChecker(java.lang.String className)
ProcessBuilder	addObjectData(java.lang.String dataName, java.lang.String dataTypeClassName) Adds an Object variable to the current BPM entity with an initial variable.
ProcessBuilder	addObjectData(java.lang.String dataName, java.lang.String dataTypeClassName, java.lang.Object initialValue) Adds an Object variable to the current BPM entity with an initial variable.
ProcessBuilder	addObjectData(java.lang.String dataName, java.lang.String dataTypeClassName, java.lang.String scriptingValue) Adds an Object variable to the current BPM entity with an initial variable.
ProcessBuilder	addOutgoingEvent(java.lang.String eventName) Adds an outgoing event on the current activity.
ProcessBuilder	addOutgoingEvent(java.lang.String eventName, java.lang.String destProcessName) Adds an outgoing event on the current activity.
ProcessBuilder	addOutgoingEvent(java.lang.String eventName, java.lang.String destProcessName, java.lang.String destActivityName) Adds an outgoing event on the current activity.
ProcessBuilder	addOutgoingEvent(java.lang.String eventName, java.lang.String destProcessName, java.lang.String destActivityName, long timeToLive, java.util.Map<java.lang.String,java.lang.Object> parameters) Adds an outgoing event on the current activity.
ProcessBuilder	addOutgoingEvent(java.lang.String eventName, java.lang.String destProcessName, java.lang.String destActivityName, java.util.Map<java.lang.String,java.lang.Object> parameters) Adds an outgoing event on the current activity.
ProcessBuilder	addOutputParameter(java.lang.String groovyExpression, java.lang.String variableName) Adds an output parameter on the current connector.
ProcessBuilder	addParameter(java.lang.String fieldName, java.lang.Object... value) Deprecated.
ProcessBuilder	addReceiveEventConnector(java.lang.String className, boolean throwingException) Adds a connector to the current received event.
ProcessBuilder	addReceiveEventTask(java.lang.String taskName, java.lang.String eventName) Adds a received event task.
ProcessBuilder	addReceiveEventTask(java.lang.String taskName, java.lang.String eventName, java.lang.String expression) Adds a received event task.
ProcessBuilder	addSendEventTask(java.lang.String taskName) Adds a send event task.
ProcessBuilder	addShortData(java.lang.String dataName) Adds a Short variable to the current BPM entity.
ProcessBuilder	addShortData(java.lang.String dataName, java.lang.Short initialValue) Adds a Short variable to the current BPM entity with an initial variable.
ProcessBuilder	addShortData(java.lang.String dataName, java.lang.String scriptingValue) Adds a Short variable to the current BPM entity with an initial variable.
ProcessBuilder	addSplitType(ActivityDefinition.SplitType split) Defines the split type of an activity
ProcessBuilder	addStringData(java.lang.String dataName) Adds a String variable to the current BPM entity.
ProcessBuilder	addStringData(java.lang.String dataName, java.lang.String initialValue) Adds a String variable to the current BPM entity with an initial variable.
ProcessBuilder	addStringDataFromScript(java.lang.String dataName, java.lang.String scriptingValue) Adds a String variable to the current BPM entity with an initial variable.
ProcessBuilder	addSubProcess(java.lang.String taskName, java.lang.String processName) Adds a sub-process.
ProcessBuilder	addSubProcess(java.lang.String taskName, java.lang.String processName, java.lang.String version) Adds a sub-process.
ProcessBuilder	addSubProcessInParameter(java.lang.String parentProcessDatafieldName, java.lang.String subProcessDatafieldName) Adds an input parameter on the current sub-process entity.
ProcessBuilder	addSubProcessOutParameter(java.lang.String subProcessDatafieldName, java.lang.String parentProcessDatafieldName) Adds an output parameter on the current sub-process entity.
ProcessBuilder	addSystemTask(java.lang.String taskName) Adds a system task.
ProcessBuilder	addTimerTask(java.lang.String taskName, java.lang.String condition) Adds a timer.
ProcessBuilder	addTransition(java.lang.String fromActivityName, java.lang.String toActivityName) Adds a transition between two activities.
ProcessBuilder	addTransition(java.lang.String transitionName, java.lang.String fromActivityName, java.lang.String toActivityName) Adds a transition between two activities.
ProcessBuilder	asynchronous() Defines that the current activity is asynchronous.
static ProcessBuilder	createProcess(java.lang.String name, java.lang.String version) Creates a process definition with a unique name and a process version.
static ProcessDefinition	createProcessFromXmlDefFile(java.net.URL xmlDefUrl) Creates a process definition using an XML process definition file.
static ProcessDefinition	createProcessFromXpdlFile(java.net.URL xpdlUrl) Creates a process definition using an XPDL file.
ProcessDefinition	done() Finishes the process definition.
ProcessBuilder	setDefault() Set the last transition as the default transition

Methods inherited from class java.lang.Object

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

Method Detail

createProcess

public static ProcessBuilder createProcess(java.lang.String name,
                                           java.lang.String version)

Creates a process definition with a unique name and a process version. In order to get this process definition the done method should be called at the end of the process build.

Parameters:

name - the process name

version - the process version

Returns:

the ProcessBuilder in order to add BPM elements

createProcessFromXpdlFile

public static ProcessDefinition createProcessFromXpdlFile(java.net.URL xpdlUrl)

Creates a process definition using an XPDL file.

Parameters:

xpdlUrl - the URL of the XPDL file

Returns:

a process definition

createProcessFromXmlDefFile

public static ProcessDefinition createProcessFromXmlDefFile(java.net.URL xmlDefUrl)

Creates a process definition using an XML process definition file.

Parameters:

xmlDefUrl - the URL of the XML process definition file

Returns:

a process definition

addDescription

public ProcessBuilder addDescription(java.lang.String description)

Adds a description to the current BPM entity.

Parameters:

description - the BPM entity description

Returns:

the ProcessBuilder in order to add BPM elements

addLabel

public ProcessBuilder addLabel(java.lang.String label)

Adds a label to the current BPM entity.

Parameters:

label - the BPM label

Returns:

the ProcessBuilder in order to add BPM elements

addCharData

public ProcessBuilder addCharData(java.lang.String dataName)

Adds a Character variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addShortData

public ProcessBuilder addShortData(java.lang.String dataName)

Adds a Short variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addLongData

public ProcessBuilder addLongData(java.lang.String dataName)

Adds a Long variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addDoubleData

public ProcessBuilder addDoubleData(java.lang.String dataName)

Adds a Double variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addFloatData

public ProcessBuilder addFloatData(java.lang.String dataName)

Adds a Float variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addBooleanData

public ProcessBuilder addBooleanData(java.lang.String dataName)

Adds a Boolean variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addIntegerData

public ProcessBuilder addIntegerData(java.lang.String dataName)

Adds a Integer variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addStringData

public ProcessBuilder addStringData(java.lang.String dataName)

Adds a String variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addDateData

public ProcessBuilder addDateData(java.lang.String dataName)

Adds a Date variable to the current BPM entity. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addCharData

public ProcessBuilder addCharData(java.lang.String dataName,
                                  java.lang.Character initialValue)

Adds a Character variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the character value

Returns:

the ProcessBuilder in order to add BPM elements

addCharData

public ProcessBuilder addCharData(java.lang.String dataName,
                                  java.lang.String scriptingValue)

Adds a Character variable to the current BPM entity. This entity must be the process itself or a process activity. The scriptingValue

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addShortData

public ProcessBuilder addShortData(java.lang.String dataName,
                                   java.lang.Short initialValue)

Adds a Short variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the short value

Returns:

the ProcessBuilder in order to add BPM elements

addShortData

public ProcessBuilder addShortData(java.lang.String dataName,
                                   java.lang.String scriptingValue)

Adds a Short variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addLongData

public ProcessBuilder addLongData(java.lang.String dataName,
                                  java.lang.Long initialValue)

Adds a Long variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the long value

Returns:

the ProcessBuilder in order to add BPM elements

addLongData

public ProcessBuilder addLongData(java.lang.String dataName,
                                  java.lang.String scriptingValue)

Adds a Long variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addDoubleData

public ProcessBuilder addDoubleData(java.lang.String dataName,
                                    java.lang.Double initialValue)

Adds a Double variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the double value

Returns:

the ProcessBuilder in order to add BPM elements

addDoubleData

public ProcessBuilder addDoubleData(java.lang.String dataName,
                                    java.lang.String scriptingValue)

Adds a Double variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addFloatData

public ProcessBuilder addFloatData(java.lang.String dataName,
                                   java.lang.Float initialValue)

Adds a Float variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the float value

Returns:

the ProcessBuilder in order to add BPM elements

addFloatData

public ProcessBuilder addFloatData(java.lang.String dataName,
                                   java.lang.String scriptingValue)

Adds a Float variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addBooleanData

public ProcessBuilder addBooleanData(java.lang.String dataName,
                                     java.lang.Boolean initialValue)

Adds a Boolean variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the boolean value

Returns:

the ProcessBuilder in order to add BPM elements

addBooleanData

public ProcessBuilder addBooleanData(java.lang.String dataName,
                                     java.lang.String scriptingValue)

Adds a Boolean variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addIntegerData

public ProcessBuilder addIntegerData(java.lang.String dataName,
                                     java.lang.Integer initialValue)

Adds an Integer variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the integer value

Returns:

the ProcessBuilder in order to add BPM elements

addIntegerData

public ProcessBuilder addIntegerData(java.lang.String dataName,
                                     java.lang.String scriptingValue)

Adds an Integer variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addStringData

public ProcessBuilder addStringData(java.lang.String dataName,
                                    java.lang.String initialValue)

Adds a String variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the string value

Returns:

the ProcessBuilder in order to add BPM elements

addStringDataFromScript

public ProcessBuilder addStringDataFromScript(java.lang.String dataName,
                                              java.lang.String scriptingValue)

Adds a String variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addDateData

public ProcessBuilder addDateData(java.lang.String dataName,
                                  java.util.Date initialValue)

Adds a Date variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

initialValue - the date value

Returns:

the ProcessBuilder in order to add BPM elements

addDateData

public ProcessBuilder addDateData(java.lang.String dataName,
                                  java.lang.String scriptingValue)

Adds a Date variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

Returns:

the ProcessBuilder in order to add BPM elements

addEnumData

public ProcessBuilder addEnumData(java.lang.String dataName,
                                  java.util.Set<java.lang.String> enumeariontValues,
                                  java.lang.String initialValue)

Adds an Enumeration variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

enumeariontValues - the value of each enumeration member

initialValue - the initial enumeration value

Returns:

the ProcessBuilder in order to add BPM elements

addEnumData

public ProcessBuilder addEnumData(java.lang.String dataName,
                                  java.lang.String scriptingValue,
                                  java.util.Set<java.lang.String> enumeariontValues)

Adds an Enumeration variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

scriptingValue - the Groovy expression as initial value

enumeariontValues - the value of each enumeration member

Returns:

the ProcessBuilder in order to add BPM elements

addAttachment

public ProcessBuilder addAttachment(java.lang.String name)

Adds an attachment on a process.

Parameters:

name - the attachment name

Returns:

the ProcessBuilder in order to add BPM elements

addAttachment

public ProcessBuilder addAttachment(java.lang.String name,
                                    java.lang.String filePath)

Adds an attachment on a process.

Parameters:

name - the attachment name

filePath - the attachment file path

Returns:

the ProcessBuilder in order to add BPM elements

addAttachment

public ProcessBuilder addAttachment(java.lang.String name,
                                    java.lang.String filePath,
                                    java.lang.String fileName)

Adds an attachment on a process.

Parameters:

name - the attachment name

filePath - the attachment file path

fileName - the attachment file name

Returns:

the ProcessBuilder in order to add BPM elements

addObjectData

public ProcessBuilder addObjectData(java.lang.String dataName,
                                    java.lang.String dataTypeClassName)

Adds an Object variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

dataTypeClassName - the data type class name

Returns:

the ProcessBuilder in order to add BPM elements

addObjectData

public ProcessBuilder addObjectData(java.lang.String dataName,
                                    java.lang.String dataTypeClassName,
                                    java.lang.Object initialValue)

Adds an Object variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

dataTypeClassName - the variable type class name

initialValue - the initial value of the variable

Returns:

the ProcessBuilder in order to add BPM elements

addObjectData

public ProcessBuilder addObjectData(java.lang.String dataName,
                                    java.lang.String dataTypeClassName,
                                    java.lang.String scriptingValue)

Adds an Object variable to the current BPM entity with an initial variable. This entity must be the process itself or a process activity.

Parameters:

dataName - the variable name

dataTypeClassName - the variable type class name

scriptingValue -

Returns:

the ProcessBuilder in order to add BPM elements

addGroup

public ProcessBuilder addGroup(java.lang.String groupName)

Adds a group.

Parameters:

groupName - the group name

Returns:

the ProcessBuilder in order to add BPM elements

addGroupResolver

public ProcessBuilder addGroupResolver(java.lang.String groupResolverClassName)

Adds a RoleResolver to a group.

Parameters:

groupResolverClassName - the RoleResolver class name

Returns:

the ProcessBuilder in order to add BPM elements

addHuman

public ProcessBuilder addHuman(java.lang.String humanName)

Adds a human to a process.

Parameters:

humanName - the human name

Returns:

the ProcessBuilder in order to add BPM elements

addSystemTask

public ProcessBuilder addSystemTask(java.lang.String taskName)

Adds a system task. By default The join type is XOR and the split types is AND.

Parameters:

taskName - the system task name

Returns:

the ProcessBuilder in order to add BPM elements

addHumanTask

public ProcessBuilder addHumanTask(java.lang.String taskName,
                                   java.lang.String... authorityNames)

Add a human task. By default The join type is XOR and the split types is AND.

Parameters:

taskName - the human task name

authorityNames - the group name(s) or a user name(s)

Returns:

the ProcessBuilder in order to add BPM elements

addSubProcess

public ProcessBuilder addSubProcess(java.lang.String taskName,
                                    java.lang.String processName)

Adds a sub-process. By default The join type is XOR and the split types is AND.

Parameters:

taskName - the task name

processName - the sub-process name.

Returns:

the ProcessBuilder in order to add BPM elements

addSubProcess

public ProcessBuilder addSubProcess(java.lang.String taskName,
                                    java.lang.String processName,
                                    java.lang.String version)

Adds a sub-process. By default The join type is XOR and the split types is AND.

Parameters:

taskName - the task name

processName - the sub-process name.

version - the sub-process version.

Returns:

the ProcessBuilder in order to add BPM elements

addSubProcessInParameter

public ProcessBuilder addSubProcessInParameter(java.lang.String parentProcessDatafieldName,
                                               java.lang.String subProcessDatafieldName)

Adds an input parameter on the current sub-process entity.

Parameters:

parentProcessDatafieldName - the parent process variable name

subProcessDatafieldName - the sub-process variable name

Returns:

the ProcessBuilder in order to add BPM elements

addSubProcessOutParameter

public ProcessBuilder addSubProcessOutParameter(java.lang.String subProcessDatafieldName,
                                                java.lang.String parentProcessDatafieldName)

Adds an output parameter on the current sub-process entity.

Parameters:

parentProcessDatafieldName - the parent process variable name

subProcessDatafieldName - the sub-process variable name

Returns:

the ProcessBuilder in order to add BPM elements

addDecisionNode

public ProcessBuilder addDecisionNode(java.lang.String taskName)

Add a decision node to the ProcessBuilder. By default The join type is XOR and the split types is AND.

Parameters:

taskName - the decision node name

Returns:

the ProcessBuilder in order to add BPM elements

addDeadline

public ProcessBuilder addDeadline(java.lang.String condition,
                                  java.lang.String connectorClassName)

Add a deadline to the current activity.

Parameters:

condition - the deadline condition.

connectorClassName - the Connector class name

Returns:

the ProcessBuilder in order to add BPM elements

addConnector

public ProcessBuilder addConnector(HookDefinition.Event event,
                                   java.lang.String className,
                                   boolean throwingException)

Adds a connector to an activity or a process.

Parameters:

className - the connector class name

event - the connector event

throwingException - if the connector throws exception

Returns:

the ProcessBuilder in order to add BPM elements

addInputParameter

public ProcessBuilder addInputParameter(java.lang.String fieldName,
                                        java.lang.Object... value)

Adds an input parameter on the current connector.

Parameters:

fieldName - a connector field name

value - the value(s) to set

Returns:

the ProcessBuilder in order to add BPM elements

addParameter

@Deprecated
public ProcessBuilder addParameter(java.lang.String fieldName,
                                              java.lang.Object... value)

Deprecated.

See Also:

addInputParameter(String, Object...)

addOutputParameter

public ProcessBuilder addOutputParameter(java.lang.String groovyExpression,
                                         java.lang.String variableName)

Adds an output parameter on the current connector. The result of Groovy expression (containing getter fields) will be set in the variable name.

Parameters:

groovyExpression - the Groovy expression.

variableName - the variable name

Returns:

the ProcessBuilder in order to add BPM elements

addFilter

public ProcessBuilder addFilter(java.lang.String className)

Add a filter to an activity (A filter is a specific connector)

Parameters:

className - the filter class name

Returns:

the ProcessBuilder in order to add BPM elements

addMultiInstanciation

@Deprecated
public ProcessBuilder addMultiInstanciation(java.lang.String variableName,
                                                       java.lang.String className)

Deprecated.

Adds a multiInstantiation to an activity.

Parameters:

variableName - the variable name

className - the multi-instantiation class name

Returns:

the ProcessBuilder in order to add BPM elements

addMultipleActivitiesInstantiator

public ProcessBuilder addMultipleActivitiesInstantiator(java.lang.String className)

addMultipleActivitiesJoinChecker

public ProcessBuilder addMultipleActivitiesJoinChecker(java.lang.String className)

asynchronous

public ProcessBuilder asynchronous()

Defines that the current activity is asynchronous.

Returns:

the ProcessBuilder in order to add BPM elements

addJoinType

public ProcessBuilder addJoinType(ActivityDefinition.JoinType join)

Defines the join type of an activity.

Parameters:

join - the join type

Returns:

the ProcessBuilder in order to add BPM elements

addSplitType

public ProcessBuilder addSplitType(ActivityDefinition.SplitType split)

Defines the split type of an activity

Parameters:

split - the split type

Returns:

the ProcessBuilder in order to add BPM elements

addDynamicDescription

public ProcessBuilder addDynamicDescription(java.lang.String dynamicDescription)

Adds a dynamic description to the current BPM entity.

Parameters:

dynamicDescription - the BPM entity dynamicDescription

Returns:

the ProcessBuilder in order to add BPM elements

addDynamicLabel

public ProcessBuilder addDynamicLabel(java.lang.String dynamicLabel)

Adds a dynamic label to the current BPM entity.

Parameters:

dynamicLabel - the BPM entity dynamicLabel

Returns:

the ProcessBuilder in order to add BPM elements

addTimerTask

public ProcessBuilder addTimerTask(java.lang.String taskName,
                                   java.lang.String condition)

Adds a timer.

Parameters:

taskName - the timer name.

condition - the timer condition.

Returns:

the ProcessBuilder in order to add BPM elements

addReceiveEventTask

public ProcessBuilder addReceiveEventTask(java.lang.String taskName,
                                          java.lang.String eventName)

Adds a received event task.

Parameters:

taskName - the task name

eventName - the event name

Returns:

the ProcessBuilder in order to add BPM elements

addReceiveEventTask

public ProcessBuilder addReceiveEventTask(java.lang.String taskName,
                                          java.lang.String eventName,
                                          java.lang.String expression)

Adds a received event task.

Parameters:

taskName - the task name

eventName - the event name

expression - the expression

Returns:

the ProcessBuilder in order to add BPM elements

addReceiveEventConnector

public ProcessBuilder addReceiveEventConnector(java.lang.String className,
                                               boolean throwingException)

Adds a connector to the current received event.

Parameters:

className - the connector class name

throwingException - if the connector throws exception.

Returns:

the ProcessBuilder in order to add BPM elements

addSendEventTask

public ProcessBuilder addSendEventTask(java.lang.String taskName)

Adds a send event task.

Parameters:

taskName - the task name.

Returns:

the ProcessBuilder in order to add BPM elements

addOutgoingEvent

public ProcessBuilder addOutgoingEvent(java.lang.String eventName)

Adds an outgoing event on the current activity.

Parameters:

eventName - the event name

Returns:

the ProcessBuilder in order to add BPM elements

addOutgoingEvent

public ProcessBuilder addOutgoingEvent(java.lang.String eventName,
                                       java.lang.String destProcessName)

Adds an outgoing event on the current activity.

Parameters:

eventName - the event name

destProcessName - the destination process

Returns:

the ProcessBuilder in order to add BPM elements

addOutgoingEvent

public ProcessBuilder addOutgoingEvent(java.lang.String eventName,
                                       java.lang.String destProcessName,
                                       java.lang.String destActivityName)

Adds an outgoing event on the current activity.

Parameters:

eventName - the event name

destProcessName - the destination process

destActivityName - the destination activity

Returns:

the ProcessBuilder in order to add BPM elements

addOutgoingEvent

public ProcessBuilder addOutgoingEvent(java.lang.String eventName,
                                       java.lang.String destProcessName,
                                       java.lang.String destActivityName,
                                       java.util.Map<java.lang.String,java.lang.Object> parameters)

Adds an outgoing event on the current activity.

Parameters:

eventName - the event name

destProcessName - the destination process

destActivityName - the destination activity

parameters - the parameters to transfer

Returns:

the ProcessBuilder in order to add BPM elements

addOutgoingEvent

public ProcessBuilder addOutgoingEvent(java.lang.String eventName,
                                       java.lang.String destProcessName,
                                       java.lang.String destActivityName,
                                       long timeToLive,
                                       java.util.Map<java.lang.String,java.lang.Object> parameters)

Adds an outgoing event on the current activity.

Parameters:

eventName - the event name

destProcessName - the destination process

destActivityName - the destination activity

timeToLive - the time to live of this event

parameters - the parameters to transfer

Returns:

the ProcessBuilder in order to add BPM elements

addActivityExecutingTime

public ProcessBuilder addActivityExecutingTime(long executingTime)

Adds an executing time (in ms) to the current activity. This time should be greater than 1s.

Parameters:

executingTime - the executing time fo the activity

Returns:

the ProcessBuilder in order to add BPM elements

addActivityPriority

public ProcessBuilder addActivityPriority(int priority)

Adds a priority to the current activity.

Parameters:

priority - the activity priority.

Returns:

the ProcessBuilder in order to add BPM elements

addLoop

public ProcessBuilder addLoop(java.lang.String condition,
                              boolean beforeExecution)

addLoop

public ProcessBuilder addLoop(java.lang.String condition,
                              boolean beforeExecution,
                              java.lang.String loopMaximum)

addTransition

public ProcessBuilder addTransition(java.lang.String fromActivityName,
                                    java.lang.String toActivityName)

Adds a transition between two activities.

Parameters:

fromActivityName - the activity name where the transition leaves

toActivityName - the activity name where the transition arrives

Returns:

the ProcessBuilder in order to add BPM elements

addTransition

public ProcessBuilder addTransition(java.lang.String transitionName,
                                    java.lang.String fromActivityName,
                                    java.lang.String toActivityName)

Adds a transition between two activities.

Parameters:

transitionName - the transition name

fromActivityName - the activity name where the transition leaves

toActivityName - the activity name where the transition arrives

Returns:

the ProcessBuilder in order to add BPM elements

setDefault

public ProcessBuilder setDefault()

Set the last transition as the default transition

Returns:

the ProcessBuilder in order to add BPM elements

addCondition

public ProcessBuilder addCondition(java.lang.String expression)

Adds a condition on a transition

Parameters:

expression - the condition.

Returns:

the ProcessBuilder in order to add BPM elements

done

public ProcessDefinition done()

Finishes the process definition. This method checks how the definition was done and throws all the errors that the process definition contains.

Returns:

the process definition ready to use.