Package org.flowable.form.api

Interface FormService

public interface FormService

Author:

Tijs Rademakers

Method Summary

Modifier and Type	Method	Description
FormInstance	createFormInstance(Map<String,Object> variables, FormInfo formInfo, String taskId, String processInstanceId, String processDefinitionId, String tenantId, String outcome)	Store the submitted form values.
FormInstanceQuery	createFormInstanceQuery()
FormInstance	createFormInstanceWithScopeId(Map<String,Object> variables, FormInfo formInfo, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
void	deleteFormInstance(String formInstanceId)
void	deleteFormInstancesByFormDefinition(String formDefinitionId)
void	deleteFormInstancesByProcessDefinition(String processDefinitionId)
void	deleteFormInstancesByScopeDefinition(String scopeDefinitionId)
FormInstanceInfo	getFormInstanceModelById(String formDefinitionId, String taskId, String processInstanceId, Map<String,Object> variables)
FormInstanceInfo	getFormInstanceModelById(String formDefinitionId, String taskId, String processInstanceId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInstanceInfo	getFormInstanceModelById(String formInstanceId, Map<String,Object> variables)
FormInstanceInfo	getFormInstanceModelByKey(String formDefinitionKey, String taskId, String processInstanceId, Map<String,Object> variables)
FormInstanceInfo	getFormInstanceModelByKey(String formDefinitionKey, String taskId, String processInstanceId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInstanceInfo	getFormInstanceModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, String processInstanceId, Map<String,Object> variables)
FormInstanceInfo	getFormInstanceModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, String processInstanceId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInstanceInfo	getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId(String formDefinitionKey, String parentDeploymentId, String scopeId, String scopeType, Map<String,Object> variables)
FormInstanceInfo	getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId(String formDefinitionKey, String parentDeploymentId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInstanceInfo	getFormInstanceModelByKeyAndScopeId(String formDefinitionKey, String scopeId, String scopeType, Map<String,Object> variables)
FormInstanceInfo	getFormInstanceModelByKeyAndScopeId(String formDefinitionKey, String scopeId, String scopeType, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
byte[]	getFormInstanceValues(String formInstanceId)
FormInfo	getFormModelWithVariablesById(String formDefinitionId, String taskId, Map<String,Object> variables)
FormInfo	getFormModelWithVariablesById(String formDefinitionId, String taskId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	getFormModelWithVariablesByKey(String formDefinitionKey, String taskId, Map<String,Object> variables)
FormInfo	getFormModelWithVariablesByKey(String formDefinitionKey, String taskId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	getFormModelWithVariablesByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, Map<String,Object> variables)
FormInfo	getFormModelWithVariablesByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
Map<String,Object>	getVariablesFromFormSubmission(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, FormInfo formInfo, Map<String,Object> values, String outcome)
FormInstance	saveFormInstance(Map<String,Object> variables, FormInfo formInfo, String taskId, String processInstanceId, String processDefinitionId, String tenantId, String outcome)
FormInstance	saveFormInstanceByFormDefinitionId(Map<String,Object> variables, String formDefinitionId, String taskId, String processInstanceId, String processDefinitionId, String tenantId, String outcome)
FormInstance	saveFormInstanceWithScopeId(Map<String,Object> variables, String formDefinitionId, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
FormInstance	saveFormInstanceWithScopeId(Map<String,Object> variables, FormInfo formInfo, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
void	validateFormFields(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, FormInfo formInfo, Map<String,Object> values)	Apply validation restrictions on the submitted variables

Method Detail

validateFormFields

void validateFormFields(String elementId,
                        String elementType,
                        String scopeId,
                        String scopeDefinitionId,
                        String scopeType,
                        FormInfo formInfo,
                        Map<String,Object> values)

Apply validation restrictions on the submitted variables

Parameters:

formInfo - form description

values - submitted variables

Throws:

FlowableException - in the case when validation failed

getVariablesFromFormSubmission

Map<String,Object> getVariablesFromFormSubmission(String elementId,
                                                        String elementType,
                                                        String scopeId,
                                                        String scopeDefinitionId,
                                                        String scopeType,
                                                        FormInfo formInfo,
                                                        Map<String,Object> values,
                                                        String outcome)

Parameters:

formInfo - form definition to use for type-conversion and validation

values - values submitted by the user

outcome - outcome selected by the user. If null, no outcome is used and any outcome definitions are ignored.

Returns:

raw variables that can be used in the process engine, based on the filled in values and selected outcome.

createFormInstance

FormInstance createFormInstance(Map<String,Object> variables,
                                FormInfo formInfo,
                                String taskId,
                                String processInstanceId,
                                String processDefinitionId,
                                String tenantId,
                                String outcome)

Store the submitted form values.

Parameters:

formInfo - form instance of the submitted form

taskId - task instance id of the completed task

processInstanceId - process instance id of the completed task

variables - json node with the values of the

saveFormInstance

FormInstance saveFormInstance(Map<String,Object> variables,
                              FormInfo formInfo,
                              String taskId,
                              String processInstanceId,
                              String processDefinitionId,
                              String tenantId,
                              String outcome)

saveFormInstanceByFormDefinitionId

FormInstance saveFormInstanceByFormDefinitionId(Map<String,Object> variables,
                                                String formDefinitionId,
                                                String taskId,
                                                String processInstanceId,
                                                String processDefinitionId,
                                                String tenantId,
                                                String outcome)

createFormInstanceWithScopeId

FormInstance createFormInstanceWithScopeId(Map<String,Object> variables,
                                           FormInfo formInfo,
                                           String taskId,
                                           String scopeId,
                                           String scopeType,
                                           String scopeDefinitionId,
                                           String tenantId,
                                           String outcome)

saveFormInstanceWithScopeId

FormInstance saveFormInstanceWithScopeId(Map<String,Object> variables,
                                         FormInfo formInfo,
                                         String taskId,
                                         String scopeId,
                                         String scopeType,
                                         String scopeDefinitionId,
                                         String tenantId,
                                         String outcome)

saveFormInstanceWithScopeId

FormInstance saveFormInstanceWithScopeId(Map<String,Object> variables,
                                         String formDefinitionId,
                                         String taskId,
                                         String scopeId,
                                         String scopeType,
                                         String scopeDefinitionId,
                                         String tenantId,
                                         String outcome)

getFormModelWithVariablesById

FormInfo getFormModelWithVariablesById(String formDefinitionId,
                                       String taskId,
                                       Map<String,Object> variables)

getFormModelWithVariablesById

FormInfo getFormModelWithVariablesById(String formDefinitionId,
                                       String taskId,
                                       Map<String,Object> variables,
                                       String tenantId,
                                       boolean fallbackToDefaultTenant)

getFormModelWithVariablesByKey

FormInfo getFormModelWithVariablesByKey(String formDefinitionKey,
                                        String taskId,
                                        Map<String,Object> variables)

getFormModelWithVariablesByKey

FormInfo getFormModelWithVariablesByKey(String formDefinitionKey,
                                        String taskId,
                                        Map<String,Object> variables,
                                        String tenantId,
                                        boolean fallbackToDefaultTenant)

getFormModelWithVariablesByKeyAndParentDeploymentId

FormInfo getFormModelWithVariablesByKeyAndParentDeploymentId(String formDefinitionKey,
                                                             String parentDeploymentId,
                                                             String taskId,
                                                             Map<String,Object> variables)

getFormModelWithVariablesByKeyAndParentDeploymentId

FormInfo getFormModelWithVariablesByKeyAndParentDeploymentId(String formDefinitionKey,
                                                             String parentDeploymentId,
                                                             String taskId,
                                                             Map<String,Object> variables,
                                                             String tenantId,
                                                             boolean fallbackToDefaultTenant)

getFormInstanceModelById

FormInstanceInfo getFormInstanceModelById(String formInstanceId,
                                          Map<String,Object> variables)

getFormInstanceModelById

FormInstanceInfo getFormInstanceModelById(String formDefinitionId,
                                          String taskId,
                                          String processInstanceId,
                                          Map<String,Object> variables)

getFormInstanceModelById

FormInstanceInfo getFormInstanceModelById(String formDefinitionId,
                                          String taskId,
                                          String processInstanceId,
                                          Map<String,Object> variables,
                                          String tenantId,
                                          boolean fallbackToDefaultTenant)

getFormInstanceModelByKey

FormInstanceInfo getFormInstanceModelByKey(String formDefinitionKey,
                                           String taskId,
                                           String processInstanceId,
                                           Map<String,Object> variables)

getFormInstanceModelByKey

FormInstanceInfo getFormInstanceModelByKey(String formDefinitionKey,
                                           String taskId,
                                           String processInstanceId,
                                           Map<String,Object> variables,
                                           String tenantId,
                                           boolean fallbackToDefaultTenant)

getFormInstanceModelByKeyAndParentDeploymentId

FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentId(String formDefinitionKey,
                                                                String parentDeploymentId,
                                                                String taskId,
                                                                String processInstanceId,
                                                                Map<String,Object> variables)

getFormInstanceModelByKeyAndParentDeploymentId

FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentId(String formDefinitionKey,
                                                                String parentDeploymentId,
                                                                String taskId,
                                                                String processInstanceId,
                                                                Map<String,Object> variables,
                                                                String tenantId,
                                                                boolean fallbackToDefaultTenant)

getFormInstanceModelByKeyAndScopeId

FormInstanceInfo getFormInstanceModelByKeyAndScopeId(String formDefinitionKey,
                                                     String scopeId,
                                                     String scopeType,
                                                     Map<String,Object> variables)

getFormInstanceModelByKeyAndScopeId

FormInstanceInfo getFormInstanceModelByKeyAndScopeId(String formDefinitionKey,
                                                     String scopeId,
                                                     String scopeType,
                                                     Map<String,Object> variables,
                                                     String tenantId,
                                                     boolean fallbackToDefaultTenant)

getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId

FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId(String formDefinitionKey,
                                                                          String parentDeploymentId,
                                                                          String scopeId,
                                                                          String scopeType,
                                                                          Map<String,Object> variables)

getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId

FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId(String formDefinitionKey,
                                                                          String parentDeploymentId,
                                                                          String scopeId,
                                                                          String scopeType,
                                                                          Map<String,Object> variables,
                                                                          String tenantId,
                                                                          boolean fallbackToDefaultTenant)

createFormInstanceQuery

FormInstanceQuery createFormInstanceQuery()

getFormInstanceValues

byte[] getFormInstanceValues(String formInstanceId)

deleteFormInstance

void deleteFormInstance(String formInstanceId)

deleteFormInstancesByFormDefinition

void deleteFormInstancesByFormDefinition(String formDefinitionId)

deleteFormInstancesByProcessDefinition

void deleteFormInstancesByProcessDefinition(String processDefinitionId)

deleteFormInstancesByScopeDefinition

void deleteFormInstancesByScopeDefinition(String scopeDefinitionId)