org.bonitasoft.engine.bpm.process.impl

Class ProcessDefinitionBuilder

java.lang.Object

org.bonitasoft.engine.bpm.process.impl.ProcessDefinitionBuilder

All Implemented Interfaces:

ContainerBuilder, DescriptionBuilder, FlowElementBuilder

public class ProcessDefinitionBuilder
extends Object
implements DescriptionBuilder, ContainerBuilder

Builder to define a process.

Author:

Baptiste Mesta, Yanyan Liu, Elias Ricken de Medeiros, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field and Description
protected DesignProcessDefinitionImpl	process

Constructor Summary

Constructors

Constructor and Description
ProcessDefinitionBuilder()

Method Summary

Modifier and Type	Method and Description
ActorDefinitionBuilder	addActor(String actorName) Adds an actor on this process
ActorDefinitionBuilder	addActor(String name, boolean initiator) Adds an actor on this process
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
BusinessDataDefinitionBuilder	addBusinessData(String name, String className, Expression defaultValue) Add a new BusinessDataDefinition on this process.
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
ProcessDefinitionBuilder	addContextEntry(String key, Expression expression)
ContractDefinitionBuilder	addContract()
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
ProcessDefinitionBuilder	addDescription(String description) Adds a description to current element.
ProcessDefinitionBuilder	addDisplayDescription(String description) Sets the process display description
ProcessDefinitionBuilder	addDisplayName(String name) Sets the process display name.
DocumentDefinitionBuilder	addDocumentDefinition(String name) Add a document definition in this container.
DocumentListDefinitionBuilder	addDocumentListDefinition(String name) Add a document list definition in this container.
DataDefinitionBuilder	addDoubleData(String name, Expression defaultValue) Adds a double data on this element
EndEventDefinitionBuilder	addEndEvent(String name) Adds an EndEventDefinition on this element
protected void	addError(String error)
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
ParameterDefinitionBuilder	addParameter(String parameterName, String type) Add a parameter on this process.
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
void	checkName(String name)
ProcessDefinitionBuilder	createNewInstance(String name, String version) Initiates the building of a new DesignProcessDefinition with the given name and version.
DesignProcessDefinition	done() Validates the process consistency and return it
DesignProcessDefinition	getProcess() Validates the process consistency and return it
ActorDefinitionBuilder	setActorInitiator(String actorName) Adds an actor initiator on this process.
protected void	validateBusinessData()

Methods inherited from class java.lang.Object

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

Field Detail

process

protected DesignProcessDefinitionImpl process

Constructor Detail

ProcessDefinitionBuilder

public ProcessDefinitionBuilder()

Method Detail

createNewInstance

public ProcessDefinitionBuilder createNewInstance(String name,
                                                  String version)

Initiates the building of a new DesignProcessDefinition with the given name and version. This method is the entry point of this builder. It must be called before any other method. The DesignProcessDefinition building will be completed when the method done() or getProcess() is called.

Parameters:

name - the process name

version - the process version

Returns:

this builder. Its ID is ZERO, as it is not deployed yet.

done

public DesignProcessDefinition done()
                             throws InvalidProcessDefinitionException

Validates the process consistency and return it

Returns:

the process being build

Throws:

InvalidProcessDefinitionException - when the process definition is inconsistent. The exception contains causes

addBusinessData

public BusinessDataDefinitionBuilder addBusinessData(String name,
                                                     String className,
                                                     Expression defaultValue)

Add a new BusinessDataDefinition on this process.

Parameters:

name - The name of the new BusinessDataDefinition

className - The complete name of class defining the new BusinessDataDefinition type

defaultValue - The expression representing the default value

Returns:

The BusinessDataDefinitionBuilder containing the new BusinessDataDefinition

validateBusinessData

protected void validateBusinessData()

addError

protected void addError(String error)

addDocumentDefinition

public DocumentDefinitionBuilder addDocumentDefinition(String name)

Description copied from interface: ContainerBuilder

Add a document definition in this container.

Must add also the content if the document is not external. This can be done using BusinessArchiveBuilder.addDocumentResource(org.bonitasoft.engine.bpm.bar.BarResource)

Specified by:

addDocumentDefinition in interface ContainerBuilder

Parameters:

name - name of the document definition

Returns:

the builder

addDocumentListDefinition

public DocumentListDefinitionBuilder addDocumentListDefinition(String name)

Description copied from interface: ContainerBuilder

Add a document list definition in this container.

Specified by:

addDocumentListDefinition in interface ContainerBuilder

Parameters:

name - the name of the list

Returns:

the builder to add the optional description and initial value expression

addDescription

public ProcessDefinitionBuilder 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.

addDisplayName

public ProcessDefinitionBuilder addDisplayName(String name)

Sets the process display name. When set, It is used to replace the name in the Bonita Portal

Parameters:

name - display name

Returns:

addDisplayDescription

public ProcessDefinitionBuilder addDisplayDescription(String description)

Sets the process display description

Parameters:

description - display description

Returns:

checkName

public void checkName(String name)

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

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

public UserTaskDefinitionBuilder addUserTask(String taskName,
                                             String actorName)

Description copied from interface: FlowElementBuilder

Adds an UserTaskDefinition on this element

Specified by:

addUserTask in interface FlowElementBuilder

Parameters:

taskName - The task name

actorName - The name of the actor that will perform this task

Returns:

addAutomaticTask

public AutomaticTaskDefinitionBuilder addAutomaticTask(String taskName)

Description copied from interface: FlowElementBuilder

Adds AutomaticTaskDefinition

Specified by:

addAutomaticTask in interface FlowElementBuilder

Parameters:

taskName - The task name

Returns:

addReceiveTask

public ReceiveTaskDefinitionBuilder addReceiveTask(String taskName,
                                                   String messageName)

Description copied from interface: FlowElementBuilder

Adds a ReceiveTaskDefinition on this element

Specified by:

addReceiveTask in interface FlowElementBuilder

Parameters:

taskName - The task name

messageName - The name of message to be received

Returns:

addSendTask

public SendTaskDefinitionBuilder addSendTask(String taskName,
                                             String messageName,
                                             Expression targetProcess)

Description copied from interface: FlowElementBuilder

Adds a SendTaskDefinition on this element

Specified by:

addSendTask in interface FlowElementBuilder

Parameters:

taskName - The task name

messageName - The name of message to be sent

targetProcess - The expression representing the target process name

Returns:

addManualTask

public ManualTaskDefinitionBuilder addManualTask(String name,
                                                 String actorName)

Description copied from interface: FlowElementBuilder

Adds a ManualTaskDefinition on this element

Specified by:

addManualTask in interface FlowElementBuilder

Parameters:

name - The task name

actorName - The name of the actor that will perform this task

Returns:

addTransition

public TransitionDefinitionBuilder addTransition(String source,
                                                 String target)

Description copied from interface: FlowElementBuilder

Adds a transition on this element. Source and target elements must be previously added

Specified by:

addTransition in interface FlowElementBuilder

Parameters:

source - The source element name

target - The target element name

Returns:

addTransition

public TransitionDefinitionBuilder addTransition(String source,
                                                 String target,
                                                 Expression condition)

Description copied from interface: FlowElementBuilder

Adds a conditional transition on this element. Source and target elements must be previously added

Specified by:

addTransition in interface FlowElementBuilder

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

public GatewayDefinitionBuilder addGateway(String name,
                                           GatewayType gatewayType)

Description copied from interface: FlowElementBuilder

Adds a GatewayDefinition on this element

Specified by:

addGateway in interface FlowElementBuilder

Parameters:

name - The gateway name

gatewayType - The gateway type

Returns:

addStartEvent

public StartEventDefinitionBuilder addStartEvent(String name)

Description copied from interface: FlowElementBuilder

Adds a StartEventDefinition on this element

Specified by:

addStartEvent in interface FlowElementBuilder

Parameters:

name - The start event name

Returns:

addEndEvent

public EndEventDefinitionBuilder addEndEvent(String name)

Description copied from interface: FlowElementBuilder

Adds an EndEventDefinition on this element

Specified by:

addEndEvent in interface FlowElementBuilder

Parameters:

name - The end event name

Returns:

addIntermediateCatchEvent

public IntermediateCatchEventDefinitionBuilder addIntermediateCatchEvent(String name)

Description copied from interface: FlowElementBuilder

Adds an IntermediateCatchEventDefinition on this element

Specified by:

addIntermediateCatchEvent in interface FlowElementBuilder

Parameters:

name - The intermediate catch event name

Returns:

addIntermediateThrowEvent

public IntermediateThrowEventDefinitionBuilder addIntermediateThrowEvent(String name)

Description copied from interface: FlowElementBuilder

Adds an IntermediateThrowEventDefinition on this element

Specified by:

addIntermediateThrowEvent in interface FlowElementBuilder

Parameters:

name - The intermediate throw event name

Returns:

addCallActivity

public CallActivityBuilder addCallActivity(String name,
                                           Expression callableElement,
                                           Expression callableElementVersion)

Description copied from interface: FlowElementBuilder

Adds a CallActivityDefinition on this element

Specified by:

addCallActivity in interface FlowElementBuilder

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

public SubProcessActivityDefinitionBuilder addSubProcess(String name,
                                                         boolean triggeredByEvent)

Description copied from interface: FlowElementBuilder

Adds a SubProcessDefinition on this element

Specified by:

addSubProcess in interface FlowElementBuilder

Parameters:

name - The sub process name

triggeredByEvent - true if it's an event sub-process; false if it's a subprocess

Returns:

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

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

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

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

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

Parameters:

name - The data name

defaultValue - The expression representing the default value

Returns:

addFloatData

public DataDefinitionBuilder addFloatData(String name,
                                          Expression defaultValue)

Description copied from interface: FlowElementBuilder

Adds a float data on this element

Specified by:

addFloatData in interface FlowElementBuilder

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

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

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

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

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

Parameters:

name - The data name

className - The data type class name (i.e. java.lang.String)

defaultValue - The expression representing the default value

Returns:

addActor

public ActorDefinitionBuilder addActor(String actorName)

Adds an actor on this process

Parameters:

actorName - actor name

See Also:

addActor(String, boolean)

addActor

public ActorDefinitionBuilder addActor(String name,
                                       boolean initiator)

Adds an actor on this process

Parameters:

name - actor name

initiator - defines whether it's the actor initiator (actor that's able to start the process)

Returns:

setActorInitiator

public ActorDefinitionBuilder setActorInitiator(String actorName)

Adds an actor initiator on this process. The actor initiator is the one that will start the process.

Parameters:

actorName -

Returns:

addDefaultTransition

public TransitionDefinitionBuilder addDefaultTransition(String source,
                                                        String target)

Description copied from interface: FlowElementBuilder

Adds a default transition on this element

Specified by:

addDefaultTransition in interface FlowElementBuilder

Parameters:

source - The source element name

target - The target element name

Returns:

getProcess

public DesignProcessDefinition getProcess()
                                   throws InvalidProcessDefinitionException

Validates the process consistency and return it

Returns:

the process being build

Throws:

InvalidProcessDefinitionException - when the process definition is inconsistent. The exception contains causes

addParameter

public ParameterDefinitionBuilder addParameter(String parameterName,
                                               String type)

Add a parameter on this process.

Parameters:

parameterName - The name of the new ParameterDefinition

type - The type of the new ParameterDefinition (complete class name)

Returns:

The ParameterDefinitionBuilder containing the new ParameterDefinition

addContextEntry

public ProcessDefinitionBuilder addContextEntry(String key,
                                                Expression expression)

addContract

public ContractDefinitionBuilder addContract()