FormInstance (Flowable Open Source 7.1.0.18)

public interface FormInstance

An object structure representing a submitted form.

Author:: Tijs Rademakers, Joram Barez

Method Summary

Modifier and Type

Method

Description

String

getFormDefinitionId()

Reference to the form definition of this form instance

byte[]

getFormValueBytes()

The JSON document that contains the submitted form values

String

getFormValuesId()

Reference to the JSON document id that contains the submitted form values

String

getId()

unique identifier

String

getProcessDefinitionId()

Reference to the process definition for which the form instance was created

String

getProcessInstanceId()

Reference to the process instance for which the form instance was created

String

getScopeDefinitionId()

Reference to the scope instance definition for which the form instance was created

String

getScopeId()

Reference to the scope instance for which the form instance was created

String

getScopeType()

Type of the scope instance for which the form instance was created

String

getSubmittedBy()

Reference to the user that submitted the form instance

Date

getSubmittedDate()

Submitted date for the form instance

String

getTaskId()

Reference to the task for which the form instance was created

String

getTenantId()

The tenant identifier of this form instance

Method Details
- getId
  
  String getId()
  
  unique identifier
- getFormDefinitionId
  
  String getFormDefinitionId()
  
  Reference to the form definition of this form instance
- getTaskId
  
  String getTaskId()
  
  Reference to the task for which the form instance was created
- getProcessInstanceId
  
  String getProcessInstanceId()
  
  Reference to the process instance for which the form instance was created
- getProcessDefinitionId
  
  String getProcessDefinitionId()
  
  Reference to the process definition for which the form instance was created
- getScopeId
  
  String getScopeId()
  
  Reference to the scope instance for which the form instance was created
- getScopeType
  
  String getScopeType()
  
  Type of the scope instance for which the form instance was created
- getScopeDefinitionId
  
  String getScopeDefinitionId()
  
  Reference to the scope instance definition for which the form instance was created
- getSubmittedDate
  
  Date getSubmittedDate()
  
  Submitted date for the form instance
- getSubmittedBy
  
  String getSubmittedBy()
  
  Reference to the user that submitted the form instance
- getFormValuesId
  
  String getFormValuesId()
  
  Reference to the JSON document id that contains the submitted form values
- getTenantId
  
  String getTenantId()
  
  The tenant identifier of this form instance
- getFormValueBytes
  
  byte[] getFormValueBytes()
  
  The JSON document that contains the submitted form values