org.bonitasoft.engine.bpm.process

Interface DesignProcessDefinition

All Superinterfaces:

BaseElement, BonitaObject, NamedElement, ProcessDefinition, Serializable

All Known Implementing Classes:

DesignProcessDefinitionImpl

public interface DesignProcessDefinition
extends ProcessDefinition

Represents the Design Definition of a process. It gives access to process attributes.

• display name
• description
• parameters
• actors
• search indexes

Since:

6.0.0

Version:

6.3.5

Author:

Matthieu Chaffotte, Celine Souchet, Laurent Leseigneur

Method Summary

Modifier and Type	Method and Description
ActorDefinition	getActorInitiator() Retrieves the ActorDefinition of process's actor defined as initiator.
Set<ActorDefinition>	getActors() Deprecated. As of release 6.1, replaced by getActorsList() which return the same information as a list
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() Deprecated.
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.

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

Method Detail

getDisplayName

String getDisplayName()

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

Returns:

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

getDisplayDescription

String getDisplayDescription()

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

Returns:

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

getProcessContainer

@Deprecated
FlowElementContainerDefinition getProcessContainer()

Deprecated.

Retrieves the definition of the FlowElementContainerDefinition of the process container.

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

Th

Returns:

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

getFlowElementContainer

FlowElementContainerDefinition getFlowElementContainer()

Returns a FlowElementContainerDefinition containing all flow elements of this process.

Returns:

a FlowElementContainerDefinition containing all flow elements of this process.

Since:

6.4.1

See Also:

FlowElementContainerDefinition

getParameters

Set<ParameterDefinition> getParameters()

Retrieves a Set of ParameterDefinition objects from a ProcessDefinition

Returns:

A set of ParameterDefinition objects

getActors

@Deprecated
Set<ActorDefinition> getActors()

Deprecated. As of release 6.1, replaced by getActorsList() which return the same information as a list

Retrieves a Set of ActorDefinition objects from a ProcessDefinition

Returns:

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

Since:

6.0

See Also:

getActorsList()

getActorsList

List<ActorDefinition> getActorsList()

Gets the list of all actors defined on this process.

Returns:

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

Since:

6.1

getActorInitiator

ActorDefinition getActorInitiator()

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

Returns:

The ActorDefinition of process's actor defined as initiator.

Since:

6.1

getStringIndexLabel

String getStringIndexLabel(int index)

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

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

Throws:

IndexOutOfBoundsException - if index is invalid

getStringIndexLabels

List<String> getStringIndexLabels()

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

Returns:

The label list of the search index

Throws:

IndexOutOfBoundsException - if index is invalid

getStringIndexValue

Expression getStringIndexValue(int index)

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

Parameters:

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

Returns:

The Expression of the search index

Throws:

IndexOutOfBoundsException - if index is invalid

getStringIndexValues

List<Expression> getStringIndexValues()

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

Returns:

The Expression list of the search index

getContract

ContractDefinition getContract()

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

Returns:

the process instantiation contract

getContext

List<ContextEntry> getContext()