org.flowable.form.engine.impl

Class FormServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<FormEngineConfiguration>

org.flowable.form.engine.impl.FormServiceImpl

All Implemented Interfaces:

FormService

public class FormServiceImpl
extends CommonEngineServiceImpl<FormEngineConfiguration>
implements FormService

Author:

Tijs Rademakers

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
FormServiceImpl(FormEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and 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 formInstanceId, Map<String,Object> variables)
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	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(FormInfo formInfo, Map<String,Object> values)
Map<String,Object>	getVariablesFromFormSubmission(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, FormInfo formInfo, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
FormInstance	saveFormInstanceWithScopeId(Map<String,Object> variables, String formModelId, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
void	validateFormFields(FormInfo formInfo, Map<String,Object> values) Apply validation restrictions on the submitted variables

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

FormServiceImpl

public FormServiceImpl(FormEngineConfiguration engineConfiguration)

Method Detail

validateFormFields

public void validateFormFields(FormInfo formInfo,
                               Map<String,Object> values)

Description copied from interface: FormService

Apply validation restrictions on the submitted variables

Specified by:

validateFormFields in interface FormService

Parameters:

formInfo - form description

values - submitted variables

getVariablesFromFormSubmission

public Map<String,Object> getVariablesFromFormSubmission(FormInfo formInfo,
                                                         Map<String,Object> values)

getVariablesFromFormSubmission

public Map<String,Object> getVariablesFromFormSubmission(FormInfo formInfo,
                                                         Map<String,Object> values,
                                                         String outcome)

Specified by:

getVariablesFromFormSubmission in interface FormService

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

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

Description copied from interface: FormService

Store the submitted form values.

Specified by:

createFormInstance in interface FormService

Parameters:

variables - json node with the values of the

formInfo - form instance of the submitted form

taskId - task instance id of the completed task

processInstanceId - process instance id of the completed task

saveFormInstance

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

Specified by:

saveFormInstance in interface FormService

saveFormInstanceByFormDefinitionId

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

Specified by:

saveFormInstanceByFormDefinitionId in interface FormService

createFormInstanceWithScopeId

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

Specified by:

createFormInstanceWithScopeId in interface FormService

saveFormInstanceWithScopeId

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

Specified by:

saveFormInstanceWithScopeId in interface FormService

saveFormInstanceWithScopeId

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

Specified by:

saveFormInstanceWithScopeId in interface FormService

getFormModelWithVariablesById

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

Specified by:

getFormModelWithVariablesById in interface FormService

getFormModelWithVariablesById

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

Specified by:

getFormModelWithVariablesById in interface FormService

getFormModelWithVariablesByKey

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

Specified by:

getFormModelWithVariablesByKey in interface FormService

getFormModelWithVariablesByKey

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

Specified by:

getFormModelWithVariablesByKey in interface FormService

getFormModelWithVariablesByKeyAndParentDeploymentId

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

Specified by:

getFormModelWithVariablesByKeyAndParentDeploymentId in interface FormService

getFormModelWithVariablesByKeyAndParentDeploymentId

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

Specified by:

getFormModelWithVariablesByKeyAndParentDeploymentId in interface FormService

getFormInstanceModelById

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

Specified by:

getFormInstanceModelById in interface FormService

getFormInstanceModelById

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

Specified by:

getFormInstanceModelById in interface FormService

getFormInstanceModelById

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

Specified by:

getFormInstanceModelById in interface FormService

getFormInstanceModelByKey

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

Specified by:

getFormInstanceModelByKey in interface FormService

getFormInstanceModelByKey

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

Specified by:

getFormInstanceModelByKey in interface FormService

getFormInstanceModelByKeyAndParentDeploymentId

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

Specified by:

getFormInstanceModelByKeyAndParentDeploymentId in interface FormService

getFormInstanceModelByKeyAndParentDeploymentId

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

Specified by:

getFormInstanceModelByKeyAndParentDeploymentId in interface FormService

getFormInstanceModelByKeyAndScopeId

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

Specified by:

getFormInstanceModelByKeyAndScopeId in interface FormService

getFormInstanceModelByKeyAndScopeId

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

Specified by:

getFormInstanceModelByKeyAndScopeId in interface FormService

getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId

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

Specified by:

getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId in interface FormService

getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId

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

Specified by:

getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId in interface FormService

getFormInstanceValues

public byte[] getFormInstanceValues(String formInstanceId)

Specified by:

getFormInstanceValues in interface FormService

createFormInstanceQuery

public FormInstanceQuery createFormInstanceQuery()

Specified by:

createFormInstanceQuery in interface FormService

deleteFormInstance

public void deleteFormInstance(String formInstanceId)

Specified by:

deleteFormInstance in interface FormService

deleteFormInstancesByFormDefinition

public void deleteFormInstancesByFormDefinition(String formDefinitionId)

Specified by:

deleteFormInstancesByFormDefinition in interface FormService

deleteFormInstancesByProcessDefinition

public void deleteFormInstancesByProcessDefinition(String processDefinitionId)

Specified by:

deleteFormInstancesByProcessDefinition in interface FormService

deleteFormInstancesByScopeDefinition

public void deleteFormInstancesByScopeDefinition(String scopeDefinitionId)

Specified by:

deleteFormInstancesByScopeDefinition in interface FormService