Package org.camunda.bpm.engine.form

Interface FormData

All Known Subinterfaces:

StartFormData, TaskFormData

All Known Implementing Classes:

FormDataImpl, StartFormDataImpl, TaskFormDataImpl

public interface FormData

Contains all metadata for displaying a form and serves as base interface for StartFormData and TaskFormData

Author:

Tom Baeyens, Michael Siebers, Daniel Meyer

Method Summary

Modifier and Type	Method	Description
CamundaFormRef	getCamundaFormRef()	User-defined reference to a form.
java.lang.String	getDeploymentId()	The deployment id of the process definition to which this form is related
java.util.List<FormField>	getFormFields()	returns the form fields which make up this form.
java.lang.String	getFormKey()	User-defined reference to a form.
java.util.List<FormProperty>	getFormProperties()	Deprecated.

Method Detail

getFormKey

java.lang.String getFormKey()

User-defined reference to a form. In the Camunda Tasklist application, it is assumed that the form key specifies a resource in the deployment which is the template for the form. But users are free to use this property differently. A form can be referenced either through a form key or through a CamundaFormRef.

getCamundaFormRef

CamundaFormRef getCamundaFormRef()

User-defined reference to a form. A CamundaFormRef can specify any Camunda Form deployed to the engine with any deployment. It is also possible to specify a specific version of a deployed form. A form can be referenced either through a form key or through a CamundaFormRef.

getDeploymentId

java.lang.String getDeploymentId()

The deployment id of the process definition to which this form is related

getFormProperties

@Deprecated
java.util.List<FormProperty> getFormProperties()

Deprecated.

Properties containing the dynamic information that needs to be displayed in the form.

getFormFields

java.util.List<FormField> getFormFields()

returns the form fields which make up this form.