org.camunda.bpm.engine.impl.form

Class FormPropertyImpl

java.lang.Object

org.camunda.bpm.engine.impl.form.FormPropertyImpl

All Implemented Interfaces:

FormProperty

public class FormPropertyImpl
extends Object
implements FormProperty

Author:

Tom Baeyens

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id
protected boolean	isReadable
protected boolean	isRequired
protected boolean	isWritable
protected String	name
protected FormType	type
protected String	value

Constructor Summary

Constructors

Constructor and Description
FormPropertyImpl(FormPropertyHandler formPropertyHandler)

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() The key used to submit the property in FormService.submitStartFormData(String, java.util.Map) or FormService.submitTaskFormData(String, java.util.Map)
String	getName() The display label
FormType	getType() Type of the property.
String	getValue() Optional value that should be used to display in this property
boolean	isReadable() Is this property read to be displayed in the form and made accessible with the methods FormService.getStartFormData(String) and FormService.getTaskFormData(String).
boolean	isRequired() Is this property a required input field
boolean	isWritable() Is this property expected when a user submits the form?
void	setValue(String value)

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

type

protected FormType type

isRequired

protected boolean isRequired

isReadable

protected boolean isReadable

isWritable

protected boolean isWritable

value

protected String value

Constructor Detail

FormPropertyImpl

public FormPropertyImpl(FormPropertyHandler formPropertyHandler)

Method Detail

getId

public String getId()

Description copied from interface: FormProperty

The key used to submit the property in FormService.submitStartFormData(String, java.util.Map) or FormService.submitTaskFormData(String, java.util.Map)

Specified by:

getId in interface FormProperty

getName

public String getName()

Description copied from interface: FormProperty

The display label

Specified by:

getName in interface FormProperty

getType

public FormType getType()

Description copied from interface: FormProperty

Type of the property.

Specified by:

getType in interface FormProperty

getValue

public String getValue()

Description copied from interface: FormProperty

Optional value that should be used to display in this property

Specified by:

getValue in interface FormProperty

isRequired

public boolean isRequired()

Description copied from interface: FormProperty

Is this property a required input field

Specified by:

isRequired in interface FormProperty

isReadable

public boolean isReadable()

Description copied from interface: FormProperty

Is this property read to be displayed in the form and made accessible with the methods FormService.getStartFormData(String) and FormService.getTaskFormData(String).

Specified by:

isReadable in interface FormProperty

setValue

public void setValue(String value)

isWritable

public boolean isWritable()

Description copied from interface: FormProperty

Is this property expected when a user submits the form?

Specified by:

isWritable in interface FormProperty