org.activiti.workflow.simple.definition.form

Class FormDefinition

java.lang.Object

org.activiti.workflow.simple.definition.form.FormDefinition

All Implemented Interfaces:

FormPropertyDefinitionContainer

public class FormDefinition
extends Object
implements FormPropertyDefinitionContainer

A HumanStepDefinition (or other) can have a form associated with it that a user must complete to continue the workflow. Such a form contains FormPropertyDefinitions and FormPropertyGroups or potentially a form key, when the properties are not used.

Author:

Joram Barrez, Frederik Heremans

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected List<FormPropertyGroup>	formGroups
protected String	formKey
protected List<FormPropertyDefinition>	formProperties

Constructor Summary

Constructors

Constructor and Description
FormDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormProperty(FormPropertyDefinition definition) Adds a form property to the form, not part of any group.
void	addFormPropertyGroup(FormPropertyGroup group) Adds a group of properties to this form.
FormDefinition	clone()
String	getDescription()
List<FormPropertyGroup>	getFormGroups()
String	getFormKey()
List<FormPropertyDefinition>	getFormPropertyDefinitions()
void	getFormPropertyDefinitions(List<FormPropertyDefinition> formProperties)
boolean	removeFormProperty(FormPropertyDefinition definition)
void	setDescription(String description)
void	setFormGroups(List<FormPropertyGroup> formGroups)
void	setFormKey(String formKey)
void	setValues(FormDefinition otherDefinition)

Methods inherited from class java.lang.Object

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

Field Detail

description

protected String description

formKey

protected String formKey

formProperties

protected List<FormPropertyDefinition> formProperties

formGroups

protected List<FormPropertyGroup> formGroups

Constructor Detail

FormDefinition

public FormDefinition()

Method Detail

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFormPropertyDefinitions

public List<FormPropertyDefinition> getFormPropertyDefinitions()

Specified by:

getFormPropertyDefinitions in interface FormPropertyDefinitionContainer

Returns:

All FormPropertyDefinitions that are not part of any FormPropertyGroup.

getFormPropertyDefinitions

public void getFormPropertyDefinitions(List<FormPropertyDefinition> formProperties)

addFormProperty

public void addFormProperty(FormPropertyDefinition definition)

Adds a form property to the form, not part of any group.

Specified by:

addFormProperty in interface FormPropertyDefinitionContainer

Parameters:

formProperty - the property to add.

removeFormProperty

public boolean removeFormProperty(FormPropertyDefinition definition)

Specified by:

removeFormProperty in interface FormPropertyDefinitionContainer

Parameters:

definition - the definition to remove from the container.

Returns:

true, if the definition was present in the container and was removed.

getFormGroups

public List<FormPropertyGroup> getFormGroups()

setFormGroups

public void setFormGroups(List<FormPropertyGroup> formGroups)

addFormPropertyGroup

public void addFormPropertyGroup(FormPropertyGroup group)

Adds a group of properties to this form.

Parameters:

group - the group to add.

setFormKey

public void setFormKey(String formKey)

getFormKey

public String getFormKey()

clone

public FormDefinition clone()

Overrides:

clone in class Object

setValues

public void setValues(FormDefinition otherDefinition)