FlowElementBuilder (Bonita Engine 7.7.3 common API)

All Known Subinterfaces:

ContainerBuilder

All Known Implementing Classes:

ActivityDefinitionBuilder, ActorDefinitionBuilder, AutomaticTaskDefinitionBuilder, BoundaryEventDefinitionBuilder, BusinessDataDefinitionBuilder, CallActivityBuilder, CatchErrorEventTiggerDefinitionBuilder, CatchMessageEventTriggerDefinitionBuilder, CatchSignalEventTriggerDefinitionBuilder, ConnectorDefinitionBuilder, ContractDefinitionBuilder, ContractInputDefinitionBuilder, DataDefinitionBuilder, DocumentDefinitionBuilder, DocumentListDefinitionBuilder, EndEventDefinitionBuilder, FlowElementContainerBuilder, GatewayDefinitionBuilder, InputContainerDefinitionBuilder, IntermediateCatchEventDefinitionBuilder, IntermediateThrowEventDefinitionBuilder, ManualTaskDefinitionBuilder, ParameterDefinitionBuilder, ProcessBuilder, ProcessDefinitionBuilder, ReceiveTaskDefinitionBuilder, SendTaskDefinitionBuilder, StartEventDefinitionBuilder, SubProcessActivityDefinitionBuilder, SubProcessDefinitionBuilder, TextDataDefinitionBuilder, ThrowErrorEventTriggerBuilder, ThrowMessageEventTriggerBuilder, ThrowSignalEventTriggerBuilder, TimerEventTriggerDefinitionBuilder, TransitionDefinitionBuilder, UserFilterDefinitionBuilder, UserTaskDefinitionBuilder, XMLDataDefinitionBuilder
```
public interface FlowElementBuilder
```
Since:

6.0.0

Version:

6.3.5

Author:

Matthieu Chaffotte, Celine Souchet

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AutomaticTaskDefinitionBuilder`	`addAutomaticTask(String taskName)` Adds `AutomaticTaskDefinition`
`DataDefinitionBuilder`	`addBlobData(String name, Expression defaultValue)` Adds a blob data on this element
`DataDefinitionBuilder`	`addBooleanData(String name, Expression defaultValue)` Adds a boolean data on this element
`CallActivityBuilder`	`addCallActivity(String name, Expression callableElement, Expression callableElementVersion)` Adds a `CallActivityDefinition` on this element
`ConnectorDefinitionBuilder`	`addConnector(String name, String connectorId, String version, ConnectorEvent activationEvent)` Add a connector on this element
`DataDefinitionBuilder`	`addData(String name, String className, Expression defaultValue)` Adds a data on this element
`DataDefinitionBuilder`	`addDateData(String name, Expression defaultValue)` Adds a date data on this element
`TransitionDefinitionBuilder`	`addDefaultTransition(String source, String target)` Adds a default transition on this element
`DataDefinitionBuilder`	`addDoubleData(String name, Expression defaultValue)` Adds a double data on this element
`EndEventDefinitionBuilder`	`addEndEvent(String name)` Adds an `EndEventDefinition` on this element
`DataDefinitionBuilder`	`addFloatData(String name, Expression defaultValue)` Adds a float data on this element
`GatewayDefinitionBuilder`	`addGateway(String name, GatewayType gatewayType)` Adds a `GatewayDefinition` on this element
`DataDefinitionBuilder`	`addIntegerData(String name, Expression defaultValue)` Adds a integer data on this element
`IntermediateCatchEventDefinitionBuilder`	`addIntermediateCatchEvent(String name)` Adds an `IntermediateCatchEventDefinition` on this element
`IntermediateThrowEventDefinitionBuilder`	`addIntermediateThrowEvent(String name)` Adds an `IntermediateThrowEventDefinition` on this element
`DataDefinitionBuilder`	`addLongData(String name, Expression defaultValue)` Adds a long data on this element
`TextDataDefinitionBuilder`	`addLongTextData(String name, Expression defaultValue)` Adds a long text data (more than 255 characters) on this element
`ManualTaskDefinitionBuilder`	`addManualTask(String name, String actorName)` Adds a `ManualTaskDefinition` on this element
`ReceiveTaskDefinitionBuilder`	`addReceiveTask(String taskName, String messageName)` Adds a `ReceiveTaskDefinition` on this element
`SendTaskDefinitionBuilder`	`addSendTask(String taskName, String messageName, Expression targetProcess)` Adds a `SendTaskDefinition` on this element
`DataDefinitionBuilder`	`addShortTextData(String name, Expression defaultValue)` Adds a short text data (up to 255 characters) on this element
`StartEventDefinitionBuilder`	`addStartEvent(String name)` Adds a `StartEventDefinition` on this element
`SubProcessActivityDefinitionBuilder`	`addSubProcess(String name, boolean triggeredByEvent)` Adds a `SubProcessDefinition` on this element
`TransitionDefinitionBuilder`	`addTransition(String source, String target)` Adds a transition on this element.
`TransitionDefinitionBuilder`	`addTransition(String source, String target, Expression condition)` Adds a conditional transition on this element.
`UserTaskDefinitionBuilder`	`addUserTask(String taskName, String actorName)` Adds an `UserTaskDefinition` on this element
`XMLDataDefinitionBuilder`	`addXMLData(String name, Expression defaultValue)` Adds a XML data on this element

- Method Detail
  - addIntegerData
```
DataDefinitionBuilder addIntegerData(String name,
                                     Expression defaultValue)
```
    Adds a integer data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addLongData
```
DataDefinitionBuilder addLongData(String name,
                                  Expression defaultValue)
```
    Adds a long data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addShortTextData
```
DataDefinitionBuilder addShortTextData(String name,
                                       Expression defaultValue)
```
    Adds a short text data (up to 255 characters) on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addLongTextData
```
TextDataDefinitionBuilder addLongTextData(String name,
                                          Expression defaultValue)
```
    Adds a long text data (more than 255 characters) on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addDoubleData
```
DataDefinitionBuilder addDoubleData(String name,
                                    Expression defaultValue)
```
    Adds a double data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addFloatData
```
DataDefinitionBuilder addFloatData(String name,
                                   Expression defaultValue)
```
    Adds a float data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addDateData
```
DataDefinitionBuilder addDateData(String name,
                                  Expression defaultValue)
```
    Adds a date data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addXMLData
```
XMLDataDefinitionBuilder addXMLData(String name,
                                    Expression defaultValue)
```
    Adds a XML data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addBlobData
```
DataDefinitionBuilder addBlobData(String name,
                                  Expression defaultValue)
```
    Adds a blob data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addBooleanData
```
DataDefinitionBuilder addBooleanData(String name,
                                     Expression defaultValue)
```
    Adds a boolean data on this element
    
    Parameters:
    
    name - The data name
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addData
```
DataDefinitionBuilder addData(String name,
                              String className,
                              Expression defaultValue)
```
    Adds a data on this element
    
    Parameters:
    
    name - The data name
    
    className - The data type class name (i.e. java.lang.String)
    
    defaultValue - The expression representing the default value
    
    Returns:
  - addConnector
```
ConnectorDefinitionBuilder addConnector(String name,
                                        String connectorId,
                                        String version,
                                        ConnectorEvent activationEvent)
```
    Add a connector on this element
    Must also add connector dependencies and connector implementation descriptor
    
    Parameters:
    
    name - The name the connector instance will use
    
    connectorId - The id of the Connector definition (connector implementation added in BusinessArchive must match this id in definitionId
    
    version - The version of the Connector definition
    
    activationEvent - ConnectorEvent on which the connector will be triggered
    
    Returns:
    
    See Also:
    
    BusinessArchiveBuilder.addClasspathResource(org.bonitasoft.engine.bpm.bar.BarResource), BusinessArchiveBuilder.addConnectorImplementation(org.bonitasoft.engine.bpm.bar.BarResource)
  - addUserTask
```
UserTaskDefinitionBuilder addUserTask(String taskName,
                                      String actorName)
```
    Adds an UserTaskDefinition on this element
    
    Parameters:
    
    taskName - The task name
    
    actorName - The name of the actor that will perform this task
    
    Returns:
  - addAutomaticTask
```
AutomaticTaskDefinitionBuilder addAutomaticTask(String taskName)
```
    Adds AutomaticTaskDefinition
    
    Parameters:
    
    taskName - The task name
    
    Returns:
  - addReceiveTask
```
ReceiveTaskDefinitionBuilder addReceiveTask(String taskName,
                                            String messageName)
```
    Adds a ReceiveTaskDefinition on this element
    
    Parameters:
    
    taskName - The task name
    
    messageName - The name of message to be received
    
    Returns:
  - addSendTask
```
SendTaskDefinitionBuilder addSendTask(String taskName,
                                      String messageName,
                                      Expression targetProcess)
```
    Adds a SendTaskDefinition on this element
    
    Parameters:
    
    taskName - The task name
    
    messageName - The name of message to be sent
    
    targetProcess - The expression representing the target process name
    
    Returns:
  - addManualTask
```
ManualTaskDefinitionBuilder addManualTask(String name,
                                          String actorName)
```
    Adds a ManualTaskDefinition on this element
    
    Parameters:
    
    name - The task name
    
    actorName - The name of the actor that will perform this task
    
    Returns:
  - addTransition
```
TransitionDefinitionBuilder addTransition(String source,
                                          String target)
```
    Adds a transition on this element. Source and target elements must be previously added
    
    Parameters:
    
    source - The source element name
    
    target - The target element name
    
    Returns:
  - addTransition
```
TransitionDefinitionBuilder addTransition(String source,
                                          String target,
                                          Expression condition)
```
    Adds a conditional transition on this element. Source and target elements must be previously added
    
    Parameters:
    
    source - The source element name
    
    target - The target element name
    
    condition - The transition condition. The transition is taken if and only if the expression is evaluated to Boolean.TRUE.
    
    Returns:
  - addGateway
```
GatewayDefinitionBuilder addGateway(String name,
                                    GatewayType gatewayType)
```
    Adds a GatewayDefinition on this element
    
    Parameters:
    
    name - The gateway name
    
    gatewayType - The gateway type
    
    Returns:
  - addStartEvent
```
StartEventDefinitionBuilder addStartEvent(String name)
```
    Adds a StartEventDefinition on this element
    
    Parameters:
    
    name - The start event name
    
    Returns:
  - addEndEvent
```
EndEventDefinitionBuilder addEndEvent(String name)
```
    Adds an EndEventDefinition on this element
    
    Parameters:
    
    name - The end event name
    
    Returns:
  - addIntermediateCatchEvent
```
IntermediateCatchEventDefinitionBuilder addIntermediateCatchEvent(String name)
```
    Adds an IntermediateCatchEventDefinition on this element
    
    Parameters:
    
    name - The intermediate catch event name
    
    Returns:
  - addIntermediateThrowEvent
```
IntermediateThrowEventDefinitionBuilder addIntermediateThrowEvent(String name)
```
    Adds an IntermediateThrowEventDefinition on this element
    
    Parameters:
    
    name - The intermediate throw event name
    
    Returns:
  - addCallActivity
```
CallActivityBuilder addCallActivity(String name,
                                    Expression callableElement,
                                    Expression callableElementVersion)
```
    Adds a CallActivityDefinition on this element
    
    Parameters:
    
    name - The call activity name
    
    callableElement - The expression representing the name of process to be called
    
    callableElementVersion - The expression representing the version of process to be called
    
    Returns:
  - addSubProcess
```
SubProcessActivityDefinitionBuilder addSubProcess(String name,
                                                  boolean triggeredByEvent)
```
    Adds a SubProcessDefinition on this element
    
    Parameters:
    
    name - The sub process name
    
    triggeredByEvent - true if it's an event sub-process; false if it's a subprocess
    
    Returns:
  - addDefaultTransition
```
TransitionDefinitionBuilder addDefaultTransition(String source,
                                                 String target)
```
    Adds a default transition on this element
    
    Parameters:
    
    source - The source element name
    
    target - The target element name
    
    Returns:

Interface FlowElementBuilder

Method Summary

Method Detail

addIntegerData

addLongData

addShortTextData

addLongTextData

addDoubleData

addFloatData

addDateData

addXMLData

addBlobData

addBooleanData

addData

addConnector

addUserTask

addAutomaticTask

addReceiveTask

addSendTask

addManualTask

addTransition

addTransition

addGateway

addStartEvent

addEndEvent

addIntermediateCatchEvent

addIntermediateThrowEvent

addCallActivity

addSubProcess

addDefaultTransition