org.camunda.bpm.engine.form

Interface FormField

All Known Implementing Classes:

FormFieldImpl, FormPropertyAdapter

public interface FormField

Represents an individual field in a form.

Author:

Michael Siebers, Daniel Meyer

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue() Deprecated.
String	getId()
String	getLabel()
Map<String,String>	getProperties()
FormType	getType()
String	getTypeName()
List<FormFieldValidationConstraint>	getValidationConstraints()
org.camunda.bpm.engine.variable.value.TypedValue	getValue()
boolean	isBusinessKey()

Method Detail

getId

String getId()

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.

getLabel

String getLabel()

Returns:

the human-readable display name of a form property.

getType

FormType getType()

Returns:

the type of this form field.

getTypeName

String getTypeName()

Returns:

the name of the type of this form field

getDefaultValue

@Deprecated
Object getDefaultValue()

Deprecated.

Returns:

the default value for this form field.

getValue

org.camunda.bpm.engine.variable.value.TypedValue getValue()

Returns:

the value for this form field

getValidationConstraints

List<FormFieldValidationConstraint> getValidationConstraints()

Returns:

a list of ValidationConstraints.

getProperties

Map<String,String> getProperties()

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.

isBusinessKey

boolean isBusinessKey()

Returns:

true if field is defined as businessKey, false otherwise