public class FormDefinition extends Object implements FormPropertyDefinitionContainer
HumanStepDefinition
(or other) can have a form associated with it
that a user must complete to continue the workflow.
Such a form contains FormPropertyDefinition
s and FormPropertyGroup
s
or potentially a form key, when the properties are not used.Modifier and Type | Field and Description |
---|---|
protected String |
description |
protected List<FormPropertyGroup> |
formGroups |
protected String |
formKey |
protected List<FormPropertyDefinition> |
formProperties |
Constructor and Description |
---|
FormDefinition() |
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) |
protected String description
protected String formKey
protected List<FormPropertyDefinition> formProperties
protected List<FormPropertyGroup> formGroups
public String getDescription()
public void setDescription(String description)
public List<FormPropertyDefinition> getFormPropertyDefinitions()
getFormPropertyDefinitions
in interface FormPropertyDefinitionContainer
FormPropertyDefinition
s that are not part of any FormPropertyGroup
.public void getFormPropertyDefinitions(List<FormPropertyDefinition> formProperties)
public void addFormProperty(FormPropertyDefinition definition)
addFormProperty
in interface FormPropertyDefinitionContainer
formProperty
- the property to add.public boolean removeFormProperty(FormPropertyDefinition definition)
removeFormProperty
in interface FormPropertyDefinitionContainer
definition
- the definition to remove from the container.public List<FormPropertyGroup> getFormGroups()
public void setFormGroups(List<FormPropertyGroup> formGroups)
public void addFormPropertyGroup(FormPropertyGroup group)
group
- the group to add.public void setFormKey(String formKey)
public String getFormKey()
public FormDefinition clone()
public void setValues(FormDefinition otherDefinition)
Copyright © 2016 Alfresco. All rights reserved.