org.camunda.bpm.engine.repository

Interface ProcessDefinition

All Superinterfaces:

ResourceDefinition

All Known Subinterfaces:

ProcessDefinitionStatistics

All Known Implementing Classes:

ProcessDefinitionEntity, ProcessDefinitionStatisticsEntity

public interface ProcessDefinition
extends ResourceDefinition

An object structure representing an executable process composed of activities and transitions. Business processes are often created with graphical editors that store the process definition in certain file format. These files can be added to a Deployment artifact, such as for example a Business Archive (.bar) file. At deploy time, the engine will then parse the process definition files to an executable instance of this class, that can be used to start a ProcessInstance.

Author:

Tom Baeyens, Joram Barez, Daniel Meyer

Method Summary

Modifier and Type	Method and Description
String	getDescription() description of this process
String	getVersionTag() Version tag of the process definition.
boolean	hasStartFormKey() Does this process definition has a start form key.
boolean	isStartableInTasklist() Returns true if the process definition is startable in Tasklist.
boolean	isSuspended() Returns true if the process definition is in suspended state.

Methods inherited from interface org.camunda.bpm.engine.repository.ResourceDefinition

getCategory, getDeploymentId, getDiagramResourceName, getHistoryTimeToLive, getId, getKey, getName, getResourceName, getTenantId, getVersion

Method Detail

getDescription

String getDescription()

description of this process

hasStartFormKey

boolean hasStartFormKey()

Does this process definition has a start form key.

isSuspended

boolean isSuspended()

Returns true if the process definition is in suspended state.

getVersionTag

String getVersionTag()

Version tag of the process definition.

isStartableInTasklist

boolean isStartableInTasklist()

Returns true if the process definition is startable in Tasklist.