org.bonitasoft.engine.bpm.process.impl.internal

Class DesignProcessDefinitionImpl

java.lang.Object

org.bonitasoft.engine.bpm.internal.BaseDefinitionElementImpl

org.bonitasoft.engine.bpm.internal.NamedDefinitionElementImpl

org.bonitasoft.engine.bpm.process.impl.internal.ProcessDefinitionImpl

org.bonitasoft.engine.bpm.process.impl.internal.DesignProcessDefinitionImpl

All Implemented Interfaces:

Serializable, BaseElement, BonitaObject, NamedElement, DesignProcessDefinition, ProcessDefinition, Visitable

public class DesignProcessDefinitionImpl
extends ProcessDefinitionImpl
implements DesignProcessDefinition, Visitable

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DesignProcessDefinitionImpl()
DesignProcessDefinitionImpl(String name, String version)

Method Summary

Modifier and Type	Method and Description
void	accept(ModelFinderVisitor visitor, long modelId)
void	addActor(ActorDefinition actor)
void	addContextEntry(ContextEntry contextEntry)
void	addParameter(ParameterDefinition parameter)
boolean	equals(Object o)
ActorDefinition	getActor(String actorName)
ActorDefinition	getActorInitiator() Retrieves the ActorDefinition of process's actor defined as initiator.
Set<ActorDefinition>	getActors() Deprecated.
List<ActorDefinition>	getActorsList() Gets the list of all actors defined on this process.
List<ContextEntry>	getContext()
ContractDefinition	getContract() Contract that must be respected when starting an instance of this process
String	getDisplayDescription() Retrieves the displayed description of the process definition, as set at design-time.
String	getDisplayName() Retrieves the displayed name of the process definition, as set at design-time.
FlowElementContainerDefinition	getFlowElementContainer() Returns a FlowElementContainerDefinition containing all flow elements of this process.
Set<ParameterDefinition>	getParameters() Retrieves a Set of ParameterDefinition objects from a ProcessDefinition
FlowElementContainerDefinition	getProcessContainer() Retrieves the definition of the FlowElementContainerDefinition of the process container.
String	getStringIndexLabel(int index) Retrieves the label for the ProcessDefinition given search index.
List<String>	getStringIndexLabels() Retrieves the label list for the ProcessDefinition given search index.
Expression	getStringIndexValue(int index) Retrieves the Expression for the ProcessDefinition given search index.
List<Expression>	getStringIndexValues() Retrieves the Expression list of the ProcessDefinition search index values.
int	hashCode()
void	setActorInitiator(ActorDefinition actorInitiator)
void	setContract(ContractDefinition contract)
void	setDisplayDescription(String description)
void	setDisplayName(String name)
void	setProcessContainer(FlowElementContainerDefinition processContainer)
void	setStringIndex(int index, String label, Expression initialValue)
String	toString()

Methods inherited from class org.bonitasoft.engine.bpm.process.impl.internal.ProcessDefinitionImpl

getDescription, getVersion, setDescription

Methods inherited from class org.bonitasoft.engine.bpm.internal.NamedDefinitionElementImpl

getName, setName

Methods inherited from class org.bonitasoft.engine.bpm.internal.BaseDefinitionElementImpl

getId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bonitasoft.engine.bpm.process.ProcessDefinition

getDescription, getVersion

Methods inherited from interface org.bonitasoft.engine.bpm.NamedElement

getName

Methods inherited from interface org.bonitasoft.engine.bpm.BaseElement

getId

Constructor Detail

DesignProcessDefinitionImpl

public DesignProcessDefinitionImpl(String name,
                                   String version)

DesignProcessDefinitionImpl

public DesignProcessDefinitionImpl()

Method Detail

setDisplayName

public void setDisplayName(String name)

setDisplayDescription

public void setDisplayDescription(String description)

getDisplayName

public String getDisplayName()

Description copied from interface: DesignProcessDefinition

Retrieves the displayed name of the process definition, as set at design-time.

Specified by:

getDisplayName in interface DesignProcessDefinition

Returns:

The displayed name of the process definition, as set at design-time.

getDisplayDescription

public String getDisplayDescription()

Description copied from interface: DesignProcessDefinition

Retrieves the displayed description of the process definition, as set at design-time.

Specified by:

getDisplayDescription in interface DesignProcessDefinition

Returns:

The displayed description of the process definition, as set at design-time.

getActorsList

public List<ActorDefinition> getActorsList()

Description copied from interface: DesignProcessDefinition

Gets the list of all actors defined on this process.

Specified by:

getActorsList in interface DesignProcessDefinition

Returns:

The list of ActorDefinition objects defined in this process.
If no actors have been defined, return an empty List.

getActors

@Deprecated
public Set<ActorDefinition> getActors()

Deprecated.

Description copied from interface: DesignProcessDefinition

Retrieves a Set of ActorDefinition objects from a ProcessDefinition

Specified by:

getActors in interface DesignProcessDefinition

Returns:

A set of ActorDefinition objects.
If no actors have been defined, return an empty Set.

See Also:

DesignProcessDefinition.getActorsList()

getParameters

public Set<ParameterDefinition> getParameters()

Description copied from interface: DesignProcessDefinition

Retrieves a Set of ParameterDefinition objects from a ProcessDefinition

Specified by:

getParameters in interface DesignProcessDefinition

Returns:

A set of ParameterDefinition objects

addParameter

public void addParameter(ParameterDefinition parameter)

addActor

public void addActor(ActorDefinition actor)

getActorInitiator

public ActorDefinition getActorInitiator()

Description copied from interface: DesignProcessDefinition

Retrieves the ActorDefinition of process's actor defined as initiator.

Specified by:

getActorInitiator in interface DesignProcessDefinition

Returns:

The ActorDefinition of process's actor defined as initiator.

setActorInitiator

public void setActorInitiator(ActorDefinition actorInitiator)

getProcessContainer

public FlowElementContainerDefinition getProcessContainer()

Description copied from interface: DesignProcessDefinition

Retrieves the definition of the FlowElementContainerDefinition of the process container.

This method is deprecated. Please, use DesignProcessDefinition.getFlowElementContainer() instead.

Th

Specified by:

getProcessContainer in interface DesignProcessDefinition

Returns:

The FlowElementContainerDefinition of the process container.
return type FlowElementContainerDefinition in this package is deprecated. Instead use FlowElementContainerDefinition

setProcessContainer

public void setProcessContainer(FlowElementContainerDefinition processContainer)

getFlowElementContainer

public FlowElementContainerDefinition getFlowElementContainer()

Description copied from interface: DesignProcessDefinition

Returns a FlowElementContainerDefinition containing all flow elements of this process.

Specified by:

getFlowElementContainer in interface DesignProcessDefinition

Returns:

a FlowElementContainerDefinition containing all flow elements of this process.

See Also:

FlowElementContainerDefinition

getStringIndexLabel

public String getStringIndexLabel(int index)

Description copied from interface: DesignProcessDefinition

Retrieves the label for the ProcessDefinition given search index.

You can define up to five search indexes for a process. See more at Define a search index Bonitasoft documentation page

Specified by:

getStringIndexLabel in interface DesignProcessDefinition

Parameters:

index - The position of search index to retrieve. Valid values are between 1 and 5 (inclusive)

Returns:

The label the Expression of the search index

getStringIndexValue

public Expression getStringIndexValue(int index)

Description copied from interface: DesignProcessDefinition

Retrieves the Expression for the ProcessDefinition given search index.

You can define up to five search indexes for a process. See more at Define a search index Bonitasoft documentation page

Specified by:

getStringIndexValue in interface DesignProcessDefinition

Parameters:

index - The position of search index to retrieve. Valid values are between 1 and 5 (inclusive)

Returns:

The Expression of the search index

getActor

public ActorDefinition getActor(String actorName)

setStringIndex

public void setStringIndex(int index,
                           String label,
                           Expression initialValue)

getContract

public ContractDefinition getContract()

Description copied from interface: DesignProcessDefinition

Contract that must be respected when starting an instance of this process

Specified by:

getContract in interface DesignProcessDefinition

Returns:

the process instantiation contract

setContract

public void setContract(ContractDefinition contract)

getContext

public List<ContextEntry> getContext()

Specified by:

getContext in interface DesignProcessDefinition

addContextEntry

public void addContextEntry(ContextEntry contextEntry)

accept

public void accept(ModelFinderVisitor visitor,
                   long modelId)

Specified by:

accept in interface Visitable

getStringIndexLabels

public List<String> getStringIndexLabels()

Description copied from interface: DesignProcessDefinition

Retrieves the label list for the ProcessDefinition given search index.

You can define up to five search indexes for a process. See more at Define a search index Bonitasoft documentation page

Specified by:

getStringIndexLabels in interface DesignProcessDefinition

Returns:

The label list of the search index

getStringIndexValues

public List<Expression> getStringIndexValues()

Description copied from interface: DesignProcessDefinition

Retrieves the Expression list of the ProcessDefinition search index values.

You can define up to five search indexes for a process. See more at Define a search index Bonitasoft documentation page

Specified by:

getStringIndexValues in interface DesignProcessDefinition

Returns:

The Expression list of the search index

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessDefinitionImpl

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessDefinitionImpl

toString

public String toString()

Overrides:

toString in class ProcessDefinitionImpl