org.flowable.form.model

Class FormModel

java.lang.Object

org.flowable.form.model.FormModel

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FormInstanceModel

public class FormModel
extends Object
implements Serializable

Author:

Joram Barrez, Tijs Rademakers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected List<FormField>	fields
protected String	id
protected String	key
protected String	name
protected List<FormOutcome>	outcomes
protected String	outcomeVariableName
protected int	version

Constructor Summary

Constructors

Constructor and Description
FormModel()

Method Summary

Modifier and Type	Method and Description
Map<String,FormField>	allFieldsAsMap()
protected void	collectSubFields(List<FormField> fields, List<FormField> listOfAllFields)
String	getDescription()
List<FormField>	getFields() Do not use this method for logical operations since it only return the top level fields.
String	getId()
String	getKey()
String	getName()
List<FormOutcome>	getOutcomes()
String	getOutcomeVariableName()
int	getVersion()
List<FormField>	listAllFields()
void	setDescription(String description)
void	setFields(List<FormField> fields)
void	setId(String id)
void	setKey(String key)
void	setName(String name)
void	setOutcomes(List<FormOutcome> outcomes)
void	setOutcomeVariableName(String outcomeVariableName)
void	setVersion(int version)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

name

protected String name

description

protected String description

key

protected String key

version

protected int version

fields

protected List<FormField> fields

outcomes

protected List<FormOutcome> outcomes

outcomeVariableName

protected String outcomeVariableName

Constructor Detail

FormModel

public FormModel()

Method Detail

getId

public String getId()

setId

public void setId(String id)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getKey

public String getKey()

setKey

public void setKey(String key)

getVersion

public int getVersion()

setVersion

public void setVersion(int version)

getFields

public List<FormField> getFields()

Do not use this method for logical operations since it only return the top level fields. I.e. A "container" field's sub fields are not returned. For verifying and listing all fields from a form use instead listAllFields().

Returns:

The top level fields, a container's sub fields are not returned.

setFields

public void setFields(List<FormField> fields)

getOutcomes

public List<FormOutcome> getOutcomes()

setOutcomes

public void setOutcomes(List<FormOutcome> outcomes)

getOutcomeVariableName

public String getOutcomeVariableName()

setOutcomeVariableName

public void setOutcomeVariableName(String outcomeVariableName)

allFieldsAsMap

public Map<String,FormField> allFieldsAsMap()

listAllFields

public List<FormField> listAllFields()

collectSubFields

protected void collectSubFields(List<FormField> fields,
                                List<FormField> listOfAllFields)