org.activiti.workflow.simple.definition

Class WorkflowDefinition

java.lang.Object

org.activiti.workflow.simple.definition.AbstractStepDefinitionContainer<WorkflowDefinition>

org.activiti.workflow.simple.definition.WorkflowDefinition

All Implemented Interfaces:

StepDefinitionContainer<WorkflowDefinition>

public class WorkflowDefinition
extends AbstractStepDefinitionContainer<WorkflowDefinition>

Allows to create simple workflows through an easy, fluent Java API. For example: WorkflowDefinition workflowDefinition = new WorkflowDefinition() .name("testWorkflow") .description("This is a test workflow") .inParallel() .addHumanStep("first task", "kermit") .addHumanStep("second step", "gonzo") .addHumanStep("thrid task", "mispiggy") .endParallel() .addHumanStep("Task in between", "kermit") .inParallel() .addHumanStep("fourth task", "gonzo") .addHumanStep("fifth step", "gonzo") .endParallel(); Feed this WorkflowDefinition instance to a WorkflowDefinitionConversion and it will convert it a to a BpmnModel, which in it turn can be used to generate valid BPMN 2.0 through the BpmnXMLConverter. The reason why we're not just using the BpmnModel and it's related classes to generate bpmn 2.0 xml, is because this class and it's related classes are a layer on top of them, allowing to easily create patterns. Such patterns are for example a parallel block (ParallelStepsDefinition) or a choice step. These can be expressed in their BpmnModel counterpart of course, but these abstraction are much easier to read and use.

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category
protected ChoiceStepsDefinition	currentChoiceStepsDefinition
protected ParallelStepsDefinition	currentParallelStepsDefinition
protected String	description
protected String	key
protected String	name
protected Map<String,Object>	parameters
protected FormDefinition	startFormDefinition

Fields inherited from class org.activiti.workflow.simple.definition.AbstractStepDefinitionContainer

id, steps

Constructor Summary

Constructors

Constructor and Description
WorkflowDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
WorkflowDefinition	category(String category)
WorkflowDefinition	description(String description)
String	getCategory()
String	getDescription()
String	getId()
String	getKey()
String	getName()
Map<String,Object>	getParameters()
FormDefinition	getStartFormDefinition()
WorkflowDefinition	id(String id)
ChoiceStepsDefinition	inChoice()
ParallelStepsDefinition	inParallel()
WorkflowDefinition	key(String key)
WorkflowDefinition	name(String name)
void	setCategory(String category)
void	setDescription(String description)
void	setId(String id)
void	setKey(String key)
void	setName(String name)
void	setParameters(Map<String,Object> parameters)
void	setStartFormDefinition(FormDefinition startFormDefinition)
WorkflowDefinition	startFormdefinition(FormDefinition startFormDefinition)

Methods inherited from class org.activiti.workflow.simple.definition.AbstractStepDefinitionContainer

addFeedbackStep, addFeedbackStep, addHumanStep, addHumanStep, addHumanStep, addHumanStepForGroup, addHumanStepForGroup, addHumanStepForGroup, addHumanStepForWorkflowInitiator, addHumanStepForWorkflowInitiator, addScriptStep, addScriptStep, addStep, createHumanStepDefinition, createHumanStepDefinition, createHumanStepDefinition, createHumanStepDefinition, getSteps

Methods inherited from class java.lang.Object

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

Field Detail

key

protected String key

name

protected String name

description

protected String description

category

protected String category

startFormDefinition

protected FormDefinition startFormDefinition

currentParallelStepsDefinition

protected ParallelStepsDefinition currentParallelStepsDefinition

currentChoiceStepsDefinition

protected ChoiceStepsDefinition currentChoiceStepsDefinition

parameters

protected Map<String,Object> parameters

Constructor Detail

WorkflowDefinition

public WorkflowDefinition()

Method Detail

getName

public String getName()

setName

public void setName(String name)

name

public WorkflowDefinition name(String name)

id

public WorkflowDefinition id(String id)

setId

public void setId(String id)

Overrides:

setId in class AbstractStepDefinitionContainer<WorkflowDefinition>

getId

public String getId()

Overrides:

getId in class AbstractStepDefinitionContainer<WorkflowDefinition>

key

public WorkflowDefinition key(String key)

getKey

public String getKey()

setKey

public void setKey(String key)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

description

public WorkflowDefinition description(String description)

getCategory

public String getCategory()

setCategory

public void setCategory(String category)

category

public WorkflowDefinition category(String category)

getParameters

public Map<String,Object> getParameters()

setParameters

public void setParameters(Map<String,Object> parameters)

inParallel

public ParallelStepsDefinition inParallel()

inChoice

public ChoiceStepsDefinition inChoice()

getStartFormDefinition

public FormDefinition getStartFormDefinition()

setStartFormDefinition

public void setStartFormDefinition(FormDefinition startFormDefinition)

startFormdefinition

public WorkflowDefinition startFormdefinition(FormDefinition startFormDefinition)