org.bonitasoft.engine.bpm.process.impl

Class ActivityDefinitionBuilder

java.lang.Object

org.bonitasoft.engine.bpm.process.impl.FlowElementContainerBuilder

org.bonitasoft.engine.bpm.process.impl.ActivityDefinitionBuilder

All Implemented Interfaces:

DescriptionBuilder, FlowElementBuilder

Direct Known Subclasses:

AutomaticTaskDefinitionBuilder, CallActivityBuilder, ManualTaskDefinitionBuilder, ReceiveTaskDefinitionBuilder, SendTaskDefinitionBuilder, UserTaskDefinitionBuilder

public class ActivityDefinitionBuilder
extends FlowElementContainerBuilder
implements DescriptionBuilder

Author:

Matthieu Chaffotte

Constructor Summary

Constructors

Constructor and Description
ActivityDefinitionBuilder(org.bonitasoft.engine.bpm.flownode.impl.internal.FlowElementContainerDefinitionImpl container, ProcessDefinitionBuilder processDefinitionBuilder, org.bonitasoft.engine.bpm.flownode.impl.internal.ActivityDefinitionImpl activity)

Method Summary

Methods

Modifier and Type	Method and Description
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
BoundaryEventDefinitionBuilder	addBoundaryEvent(String name) Adds an interrupting boundary event
BoundaryEventDefinitionBuilder	addBoundaryEvent(String name, boolean interrupting) Adds a boundary event
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
ActivityDefinitionBuilder	addDescription(String description) Adds a description to current element.
ActivityDefinitionBuilder	addDisplayDescription(Expression displayDescription) Sets the display description on this activity
ActivityDefinitionBuilder	addDisplayDescriptionAfterCompletion(Expression displayDescriptionAfterCompletion) Sets the display description after completion on this activity.
ActivityDefinitionBuilder	addDisplayName(Expression displayName) Sets the display name on this activity.
DataDefinitionBuilder	addDoubleData(String name, Expression defaultValue) Adds a double data on this element
DataDefinitionBuilder	addIntegerData(String name, Expression defaultValue) Adds a integer data 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
ActivityDefinitionBuilder	addLoop(boolean testBefore, Expression condition) Defines this activity as a loop.
ActivityDefinitionBuilder	addLoop(boolean testBefore, Expression condition, Expression loopMax) Defines this activity as a loop.
MultiInstanceLoopCharacteristicsBuilder	addMultiInstance(boolean isSequential, Expression loopCardinality) Defines this activity as a multi-instance by suppling the cardinality
MultiInstanceLoopCharacteristicsBuilder	addMultiInstance(boolean isSequential, String loopDataInput) Defines this activity as a multi-instance by suppling a collection of elements.
ActivityDefinitionBuilder	addOperation(LeftOperand leftOperand, OperatorType type, String operator, Expression rightOperand) Adds an operation on this activity.
ActivityDefinitionBuilder	addOperation(LeftOperand leftOperand, OperatorType type, String operator, String operatorInputType, Expression rightOperand) Adds an operation on this activity.
ActivityDefinitionBuilder	addOperation(Operation operation) Adds the given operation on this activity
DataDefinitionBuilder	addShortTextData(String name, Expression defaultValue) Adds a short text data (up to 255 characters) on this element
XMLDataDefinitionBuilder	addXMLData(String name, Expression defaultValue) Adds a XML data on this element

Methods inherited from class org.bonitasoft.engine.bpm.process.impl.FlowElementContainerBuilder

addAutomaticTask, addCallActivity, addDefaultTransition, addEndEvent, addFloatData, addGateway, addIntermediateCatchEvent, addIntermediateThrowEvent, addManualTask, addReceiveTask, addSendTask, addStartEvent, addSubProcess, addTransition, addTransition, addUserTask, getContainer, getProcess, getProcessBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityDefinitionBuilder

public ActivityDefinitionBuilder(org.bonitasoft.engine.bpm.flownode.impl.internal.FlowElementContainerDefinitionImpl container,
                         ProcessDefinitionBuilder processDefinitionBuilder,
                         org.bonitasoft.engine.bpm.flownode.impl.internal.ActivityDefinitionImpl activity)

Method Detail

addIntegerData

public DataDefinitionBuilder addIntegerData(String name,
                                   Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a integer data on this element

Specified by:

addIntegerData in interface FlowElementBuilder

Overrides:

addIntegerData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addLongData

public DataDefinitionBuilder addLongData(String name,
                                Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a long data on this element

Specified by:

addLongData in interface FlowElementBuilder

Overrides:

addLongData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addShortTextData

public DataDefinitionBuilder addShortTextData(String name,
                                     Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a short text data (up to 255 characters) on this element

Specified by:

addShortTextData in interface FlowElementBuilder

Overrides:

addShortTextData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addLongTextData

public TextDataDefinitionBuilder addLongTextData(String name,
                                        Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a long text data (more than 255 characters) on this element

Specified by:

addLongTextData in interface FlowElementBuilder

Overrides:

addLongTextData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addDoubleData

public DataDefinitionBuilder addDoubleData(String name,
                                  Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a double data on this element

Specified by:

addDoubleData in interface FlowElementBuilder

Overrides:

addDoubleData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addDateData

public DataDefinitionBuilder addDateData(String name,
                                Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a date data on this element

Specified by:

addDateData in interface FlowElementBuilder

Overrides:

addDateData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addXMLData

public XMLDataDefinitionBuilder addXMLData(String name,
                                  Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a XML data on this element

Specified by:

addXMLData in interface FlowElementBuilder

Overrides:

addXMLData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addBlobData

public DataDefinitionBuilder addBlobData(String name,
                                Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a blob data on this element

Specified by:

addBlobData in interface FlowElementBuilder

Overrides:

addBlobData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addBooleanData

public DataDefinitionBuilder addBooleanData(String name,
                                   Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a boolean data on this element

Specified by:

addBooleanData in interface FlowElementBuilder

Overrides:

addBooleanData in class FlowElementContainerBuilder

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addData

public DataDefinitionBuilder addData(String name,
                            String className,
                            Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a data on this element

Specified by:

addData in interface FlowElementBuilder

Overrides:

addData in class FlowElementContainerBuilder

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

public ConnectorDefinitionBuilder addConnector(String name,
                                      String connectorId,
                                      String version,
                                      ConnectorEvent activationEvent)

Description copied from interface: FlowElementBuilder

Add a connector on this element

Must also add connector dependencies and connector implementation descriptor

Specified by:

addConnector in interface FlowElementBuilder

Overrides:

addConnector in class FlowElementContainerBuilder

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)

addDescription

public ActivityDefinitionBuilder addDescription(String description)

Description copied from interface: DescriptionBuilder

Adds a description to current element.

Specified by:

addDescription in interface DescriptionBuilder

Parameters:

description - the description to set on this element.

Returns:

this DescriptionBuilder, to allow to chain the calls.

addDisplayDescription

public ActivityDefinitionBuilder addDisplayDescription(Expression displayDescription)

Sets the display description on this activity

Parameters:

displayDescription - expression representing the display description

Returns:

addDisplayName

public ActivityDefinitionBuilder addDisplayName(Expression displayName)

Sets the display name on this activity. When set, the display name will replace the name in the Bonita BPM Portal

Parameters:

displayName - expression representing the display name

Returns:

addDisplayDescriptionAfterCompletion

public ActivityDefinitionBuilder addDisplayDescriptionAfterCompletion(Expression displayDescriptionAfterCompletion)

Sets the display description after completion on this activity. This will be used to updated the display description when the activity completes its execution

Parameters:

displayDescriptionAfterCompletion - expression representing the new display description after the activity completion.

Returns:

addOperation

public ActivityDefinitionBuilder addOperation(LeftOperand leftOperand,
                                     OperatorType type,
                                     String operator,
                                     Expression rightOperand)

Adds an operation on this activity. Operations are executed between connectors ON_ENTER and connectors ON_FINISH. In the case of human tasks, operations are executed after calling the method ProcessAPI#executeFlowNode(long)

Parameters:

leftOperand - operation left operand

type - operator type

operator - operator

rightOperand - expression representing the right operand

Returns:

addOperation

public ActivityDefinitionBuilder addOperation(LeftOperand leftOperand,
                                     OperatorType type,
                                     String operator,
                                     String operatorInputType,
                                     Expression rightOperand)

Adds an operation on this activity. Operations are executed between connectors ON_ENTER and connectors ON_FINISH. In the case of human tasks, operations are executed after calling the method ProcessAPI#executeFlowNode(long)

Parameters:

leftOperand - operation left operand

type - operator type

operator - operator

operatorInputType - the input operator type. For instance, the parameter type in the case of a Java setter

rightOperand - expression representing the right operand

Returns:

addOperation

public ActivityDefinitionBuilder addOperation(Operation operation)

Adds the given operation on this activity

Parameters:

operation - operation to be added

Returns:

addLoop

public ActivityDefinitionBuilder addLoop(boolean testBefore,
                                Expression condition)

Defines this activity as a loop. The loop will finish when the condition is evaluated to false

Parameters:

testBefore - true if the condition must be check before execute the first iteration; false if the condition must be checked only after the first iteration

condition - condition determining whether the activity must loop again

Returns:

addLoop

public ActivityDefinitionBuilder addLoop(boolean testBefore,
                                Expression condition,
                                Expression loopMax)

Defines this activity as a loop. The loop will finish when the condition is evaluated to false or when the max iterations number is reached

Parameters:

testBefore - true if the condition must be check before execute the first iteration; false if the condition must be checked only after the first iteration

condition - condition determining whether the activity must loop again. The loop will finish when the condition is evaluated to false

loopMax - expression representing the max iterations number. The expression must return an Integer

Returns:

addBoundaryEvent

public BoundaryEventDefinitionBuilder addBoundaryEvent(String name,
                                              boolean interrupting)

Adds a boundary event

Parameters:

name - the name of the boundary event

interrupting - defines whether the boundary event is interrupting or not

Returns:

Since:

6.0

addBoundaryEvent

public BoundaryEventDefinitionBuilder addBoundaryEvent(String name)

Adds an interrupting boundary event

Parameters:

name - the name of the boundary event

Returns:

Since:

6.0

addMultiInstance

public MultiInstanceLoopCharacteristicsBuilder addMultiInstance(boolean isSequential,
                                                       Expression loopCardinality)

Defines this activity as a multi-instance by suppling the cardinality

Parameters:

isSequential - defines whether instances creation is sequential or not. If true, instances will be created iteration by iteration; otherwise all instances will be created during the activity initialization.

loopCardinality - expression representing how many instances must be created. The expression return type must be Integer

Returns:

addMultiInstance

public MultiInstanceLoopCharacteristicsBuilder addMultiInstance(boolean isSequential,
                                                       String loopDataInput)

Defines this activity as a multi-instance by suppling a collection of elements. One instance will be created for each element in the collection.

Parameters:

isSequential - defines whether instances creation is sequential or not. If true, instances will be created iteration by iteration; otherwise all instances will be created during the activity initialization.

loopDataInput - name of process data representing the collection of elements used to create the instances

Returns:

See Also:

MultiInstanceLoopCharacteristicsBuilder.addLoopDataOutputRef(String), MultiInstanceLoopCharacteristicsBuilder.addDataInputItemRef(String), MultiInstanceLoopCharacteristicsBuilder.addDataOutputItemRef(String)