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

Class FormDataImpl

java.lang.Object

org.camunda.bpm.engine.impl.form.FormDataImpl

All Implemented Interfaces:

java.io.Serializable, FormData

Direct Known Subclasses:

StartFormDataImpl, TaskFormDataImpl

public abstract class FormDataImpl
extends java.lang.Object
implements FormData, java.io.Serializable

Author:

Tom Baeyens, Daniel Meyer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CamundaFormRef	camundaFormRef
protected java.lang.String	deploymentId
protected java.util.List<FormField>	formFields
protected java.lang.String	formKey
protected java.util.List<FormProperty>	formProperties

Constructor Summary

Constructors

Constructor	Description
FormDataImpl()

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()	Properties containing the dynamic information that needs to be displayed in the form.
void	setCamundaFormRef(CamundaFormRef camundaFormRef)
void	setDeploymentId(java.lang.String deploymentId)
void	setFormFields(java.util.List<FormField> formFields)
void	setFormKey(java.lang.String formKey)
void	setFormProperties(java.util.List<FormProperty> formProperties)

Methods inherited from class java.lang.Object

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

Field Detail

formKey

protected java.lang.String formKey

camundaFormRef

protected CamundaFormRef camundaFormRef

deploymentId

protected java.lang.String deploymentId

formProperties

protected java.util.List<FormProperty> formProperties

formFields

protected java.util.List<FormField> formFields

Constructor Detail

FormDataImpl

public FormDataImpl()

Method Detail

getFormKey

public java.lang.String getFormKey()

Description copied from interface: FormData

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.

Specified by:

getFormKey in interface FormData

setFormKey

public void setFormKey(java.lang.String formKey)

getCamundaFormRef

public CamundaFormRef getCamundaFormRef()

Description copied from interface: FormData

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.

Specified by:

getCamundaFormRef in interface FormData

setCamundaFormRef

public void setCamundaFormRef(CamundaFormRef camundaFormRef)

getDeploymentId

public java.lang.String getDeploymentId()

Description copied from interface: FormData

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

Specified by:

getDeploymentId in interface FormData

setDeploymentId

public void setDeploymentId(java.lang.String deploymentId)

getFormProperties

public java.util.List<FormProperty> getFormProperties()

Description copied from interface: FormData

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

Specified by:

getFormProperties in interface FormData

setFormProperties

public void setFormProperties(java.util.List<FormProperty> formProperties)

getFormFields

public java.util.List<FormField> getFormFields()

Description copied from interface: FormData

returns the form fields which make up this form.

Specified by:

getFormFields in interface FormData

setFormFields

public void setFormFields(java.util.List<FormField> formFields)