Package org.camunda.bpm.engine.impl.form

Class FormFieldImpl

java.lang.Object

org.camunda.bpm.engine.impl.form.FormFieldImpl

All Implemented Interfaces:

FormField

public class FormFieldImpl
extends java.lang.Object
implements FormField

Author:

Daniel Meyer

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	businessKey
protected java.lang.Object	defaultValue
protected java.lang.String	id
protected java.lang.String	label
protected java.util.Map<java.lang.String,java.lang.String>	properties
protected FormType	type
protected java.util.List<FormFieldValidationConstraint>	validationConstraints
protected TypedValue	value

Constructor Summary

Constructors

Constructor	Description
FormFieldImpl()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getDefaultValue()
java.lang.String	getId()
java.lang.String	getLabel()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
FormType	getType()
java.lang.String	getTypeName()
java.util.List<FormFieldValidationConstraint>	getValidationConstraints()
TypedValue	getValue()
boolean	isBusinessKey()
void	setBusinessKey(boolean businessKey)
void	setDefaultValue(java.lang.Object defaultValue)
void	setId(java.lang.String id)
void	setLabel(java.lang.String label)
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
void	setType(FormType type)
void	setValidationConstraints(java.util.List<FormFieldValidationConstraint> validationConstraints)
void	setValue(TypedValue value)

Methods inherited from class java.lang.Object

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

Field Detail

businessKey

protected boolean businessKey

id

protected java.lang.String id

label

protected java.lang.String label

type

protected FormType type

defaultValue

protected java.lang.Object defaultValue

value

protected TypedValue value

validationConstraints

protected java.util.List<FormFieldValidationConstraint> validationConstraints

properties

protected java.util.Map<java.lang.String,java.lang.String> properties

Constructor Detail

FormFieldImpl

public FormFieldImpl()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface FormField

Returns:

the Id of a form property. Must be unique for a given form. The id is used for mapping the form field to a process variable.

setId

public void setId(java.lang.String id)

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface FormField

Returns:

the human-readable display name of a form property.

setLabel

public void setLabel(java.lang.String label)

getType

public FormType getType()

Specified by:

getType in interface FormField

Returns:

the type of this form field.

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface FormField

Returns:

the name of the type of this form field

setType

public void setType(FormType type)

getDefaultValue

public java.lang.Object getDefaultValue()

Specified by:

getDefaultValue in interface FormField

Returns:

the default value for this form field.

getValue

public TypedValue getValue()

Specified by:

getValue in interface FormField

Returns:

the value for this form field

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

setValue

public void setValue(TypedValue value)

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Specified by:

getProperties in interface FormField

Returns:

a Map of additional properties. This map may be used for adding additional configuration to a form field. An example may be layout hints such as the size of the rendered form field or information about an icon to prepend or append to the rendered form field.

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

getValidationConstraints

public java.util.List<FormFieldValidationConstraint> getValidationConstraints()

Specified by:

getValidationConstraints in interface FormField

Returns:

a list of ValidationConstraints.

setValidationConstraints

public void setValidationConstraints(java.util.List<FormFieldValidationConstraint> validationConstraints)

isBusinessKey

public boolean isBusinessKey()

Specified by:

isBusinessKey in interface FormField

Returns:

true if field is defined as businessKey, false otherwise

setBusinessKey

public void setBusinessKey(boolean businessKey)