Package com.flowable.form.engine.impl

Class FormServiceImpl

  • All Implemented Interfaces:
    org.flowable.form.api.FormService
    public class FormServiceImpl
extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<FormEngineConfiguration>
implements org.flowable.form.api.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 Description
      FormServiceImpl()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.flowable.form.api.FormInstance createFormInstance​(java.util.Map<java.lang.String,​java.lang.Object> variables, org.flowable.form.api.FormInfo formInfo, java.lang.String taskId, java.lang.String processInstanceId, java.lang.String processDefinitionId, java.lang.String tenantId, java.lang.String outcome)  
      org.flowable.form.api.FormInstanceQuery createFormInstanceQuery()  
      org.flowable.form.api.FormInstance createFormInstanceWithScopeId​(java.util.Map<java.lang.String,​java.lang.Object> variables, org.flowable.form.api.FormInfo formInfo, java.lang.String taskId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String scopeDefinitionId, java.lang.String tenantId, java.lang.String outcome)  
      void deleteFormInstance​(java.lang.String formInstanceId)  
      void deleteFormInstancesByFormDefinition​(java.lang.String formDefinitionId)  
      void deleteFormInstancesByProcessDefinition​(java.lang.String processDefinitionId)  
      void deleteFormInstancesByScopeDefinition​(java.lang.String scopeDefinitionId)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelById​(java.lang.String formDefinitionId, java.lang.String taskId, java.lang.String processInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelById​(java.lang.String formDefinitionId, java.lang.String taskId, java.lang.String processInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelById​(java.lang.String formInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKey​(java.lang.String formDefinitionKey, java.lang.String taskId, java.lang.String processInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKey​(java.lang.String formDefinitionKey, java.lang.String taskId, java.lang.String processInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey, java.lang.String parentDeploymentId, java.lang.String taskId, java.lang.String processInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey, java.lang.String parentDeploymentId, java.lang.String taskId, java.lang.String processInstanceId, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId​(java.lang.String formDefinitionKey, java.lang.String parentDeploymentId, java.lang.String scopeId, java.lang.String scopeType, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId​(java.lang.String formDefinitionKey, java.lang.String parentDeploymentId, java.lang.String scopeId, java.lang.String scopeType, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndScopeId​(java.lang.String formDefinitionKey, java.lang.String scopeId, java.lang.String scopeType, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndScopeId​(java.lang.String formDefinitionKey, java.lang.String scopeId, java.lang.String scopeType, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      byte[] getFormInstanceValues​(java.lang.String formInstanceId)  
      org.flowable.form.api.FormInfo getFormModelWithVariablesById​(java.lang.String formDefinitionId, java.lang.String taskId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInfo getFormModelWithVariablesById​(java.lang.String formId, java.lang.String taskId, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      org.flowable.form.api.FormInfo getFormModelWithVariablesByKey​(java.lang.String formDefinitionKey, java.lang.String taskId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInfo getFormModelWithVariablesByKey​(java.lang.String formDefinitionKey, java.lang.String taskId, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      org.flowable.form.api.FormInfo getFormModelWithVariablesByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey, java.lang.String parentDeploymentId, java.lang.String taskId, java.util.Map<java.lang.String,​java.lang.Object> variables)  
      org.flowable.form.api.FormInfo getFormModelWithVariablesByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey, java.lang.String parentDeploymentId, java.lang.String taskId, java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String tenantId, boolean fallbackToDefaultTenant)  
      java.util.Map<java.lang.String,​java.lang.Object> getSavedFormVariables​(org.flowable.form.api.FormInstance formInstance)  
      java.util.Map<java.lang.String,​java.lang.Object> getStartFormVariables​(java.lang.String processInstanceId, java.lang.String scopeId)  
      java.util.Map<java.lang.String,​java.lang.Object> getVariablesFromFormSubmission​(org.flowable.form.api.FormInfo formInfo, java.util.Map<java.lang.String,​java.lang.Object> values)  
      java.util.Map<java.lang.String,​java.lang.Object> getVariablesFromFormSubmission​(org.flowable.form.api.FormInfo formInfo, java.util.Map<java.lang.String,​java.lang.Object> values, java.lang.String outcome)  
      org.flowable.form.api.FormInstance saveFormInstance​(java.util.Map<java.lang.String,​java.lang.Object> variables, org.flowable.form.api.FormInfo formInfo, java.lang.String taskId, java.lang.String processInstanceId, java.lang.String processDefinitionId, java.lang.String tenantId, java.lang.String outcome)  
      org.flowable.form.api.FormInstance saveFormInstanceByFormDefinitionId​(java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String formDefinitionId, java.lang.String taskId, java.lang.String processInstanceId, java.lang.String processDefinitionId, java.lang.String tenantId, java.lang.String outcome)  
      org.flowable.form.api.FormInstance saveFormInstanceWithScopeId​(java.util.Map<java.lang.String,​java.lang.Object> variables, java.lang.String formModelId, java.lang.String taskId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String scopeDefinitionId, java.lang.String tenantId, java.lang.String outcome)  
      org.flowable.form.api.FormInstance saveFormInstanceWithScopeId​(java.util.Map<java.lang.String,​java.lang.Object> variables, org.flowable.form.api.FormInfo formInfo, java.lang.String taskId, java.lang.String scopeId, java.lang.String scopeType, java.lang.String scopeDefinitionId, java.lang.String tenantId, java.lang.String outcome)  
      void validateFormFields​(org.flowable.form.api.FormInfo formInfo, java.util.Map<java.lang.String,​java.lang.Object> values)  

      • 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()

    • Method Detail

      • getVariablesFromFormSubmission

        public java.util.Map<java.lang.String,​java.lang.Object> getVariablesFromFormSubmission​(org.flowable.form.api.FormInfo formInfo,
                                                                                             java.util.Map<java.lang.String,​java.lang.Object> values)

      • validateFormFields

        public void validateFormFields​(org.flowable.form.api.FormInfo formInfo,
                               java.util.Map<java.lang.String,​java.lang.Object> values)
        Specified by:
        validateFormFields in interface org.flowable.form.api.FormService

      • getVariablesFromFormSubmission

        public java.util.Map<java.lang.String,​java.lang.Object> getVariablesFromFormSubmission​(org.flowable.form.api.FormInfo formInfo,
                                                                                             java.util.Map<java.lang.String,​java.lang.Object> values,
                                                                                             java.lang.String outcome)
        Specified by:
        getVariablesFromFormSubmission in interface org.flowable.form.api.FormService

      • createFormInstance

        public org.flowable.form.api.FormInstance createFormInstance​(java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                             org.flowable.form.api.FormInfo formInfo,
                                                             java.lang.String taskId,
                                                             java.lang.String processInstanceId,
                                                             java.lang.String processDefinitionId,
                                                             java.lang.String tenantId,
                                                             java.lang.String outcome)
        Specified by:
        createFormInstance in interface org.flowable.form.api.FormService

      • saveFormInstance

        public org.flowable.form.api.FormInstance saveFormInstance​(java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                           org.flowable.form.api.FormInfo formInfo,
                                                           java.lang.String taskId,
                                                           java.lang.String processInstanceId,
                                                           java.lang.String processDefinitionId,
                                                           java.lang.String tenantId,
                                                           java.lang.String outcome)
        Specified by:
        saveFormInstance in interface org.flowable.form.api.FormService

      • saveFormInstanceByFormDefinitionId

        public org.flowable.form.api.FormInstance saveFormInstanceByFormDefinitionId​(java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                             java.lang.String formDefinitionId,
                                                                             java.lang.String taskId,
                                                                             java.lang.String processInstanceId,
                                                                             java.lang.String processDefinitionId,
                                                                             java.lang.String tenantId,
                                                                             java.lang.String outcome)
        Specified by:
        saveFormInstanceByFormDefinitionId in interface org.flowable.form.api.FormService

      • createFormInstanceWithScopeId

        public org.flowable.form.api.FormInstance createFormInstanceWithScopeId​(java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                        org.flowable.form.api.FormInfo formInfo,
                                                                        java.lang.String taskId,
                                                                        java.lang.String scopeId,
                                                                        java.lang.String scopeType,
                                                                        java.lang.String scopeDefinitionId,
                                                                        java.lang.String tenantId,
                                                                        java.lang.String outcome)
        Specified by:
        createFormInstanceWithScopeId in interface org.flowable.form.api.FormService

      • saveFormInstanceWithScopeId

        public org.flowable.form.api.FormInstance saveFormInstanceWithScopeId​(java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                      org.flowable.form.api.FormInfo formInfo,
                                                                      java.lang.String taskId,
                                                                      java.lang.String scopeId,
                                                                      java.lang.String scopeType,
                                                                      java.lang.String scopeDefinitionId,
                                                                      java.lang.String tenantId,
                                                                      java.lang.String outcome)
        Specified by:
        saveFormInstanceWithScopeId in interface org.flowable.form.api.FormService

      • saveFormInstanceWithScopeId

        public org.flowable.form.api.FormInstance saveFormInstanceWithScopeId​(java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                      java.lang.String formModelId,
                                                                      java.lang.String taskId,
                                                                      java.lang.String scopeId,
                                                                      java.lang.String scopeType,
                                                                      java.lang.String scopeDefinitionId,
                                                                      java.lang.String tenantId,
                                                                      java.lang.String outcome)
        Specified by:
        saveFormInstanceWithScopeId in interface org.flowable.form.api.FormService

      • getFormModelWithVariablesById

        public org.flowable.form.api.FormInfo getFormModelWithVariablesById​(java.lang.String formDefinitionId,
                                                                    java.lang.String taskId,
                                                                    java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormModelWithVariablesById in interface org.flowable.form.api.FormService

      • getFormModelWithVariablesById

        public org.flowable.form.api.FormInfo getFormModelWithVariablesById​(java.lang.String formId,
                                                                    java.lang.String taskId,
                                                                    java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                    java.lang.String tenantId,
                                                                    boolean fallbackToDefaultTenant)
        Specified by:
        getFormModelWithVariablesById in interface org.flowable.form.api.FormService

      • getFormModelWithVariablesByKey

        public org.flowable.form.api.FormInfo getFormModelWithVariablesByKey​(java.lang.String formDefinitionKey,
                                                                     java.lang.String taskId,
                                                                     java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormModelWithVariablesByKey in interface org.flowable.form.api.FormService

      • getFormModelWithVariablesByKey

        public org.flowable.form.api.FormInfo getFormModelWithVariablesByKey​(java.lang.String formDefinitionKey,
                                                                     java.lang.String taskId,
                                                                     java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                     java.lang.String tenantId,
                                                                     boolean fallbackToDefaultTenant)
        Specified by:
        getFormModelWithVariablesByKey in interface org.flowable.form.api.FormService

      • getFormModelWithVariablesByKeyAndParentDeploymentId

        public org.flowable.form.api.FormInfo getFormModelWithVariablesByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey,
                                                                                          java.lang.String parentDeploymentId,
                                                                                          java.lang.String taskId,
                                                                                          java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormModelWithVariablesByKeyAndParentDeploymentId in interface org.flowable.form.api.FormService

      • getFormModelWithVariablesByKeyAndParentDeploymentId

        public org.flowable.form.api.FormInfo getFormModelWithVariablesByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey,
                                                                                          java.lang.String parentDeploymentId,
                                                                                          java.lang.String taskId,
                                                                                          java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                                          java.lang.String tenantId,
                                                                                          boolean fallbackToDefaultTenant)
        Specified by:
        getFormModelWithVariablesByKeyAndParentDeploymentId in interface org.flowable.form.api.FormService

      • getFormInstanceModelById

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelById​(java.lang.String formInstanceId,
                                                                       java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormInstanceModelById in interface org.flowable.form.api.FormService

      • getFormInstanceModelById

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelById​(java.lang.String formDefinitionId,
                                                                       java.lang.String taskId,
                                                                       java.lang.String processInstanceId,
                                                                       java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormInstanceModelById in interface org.flowable.form.api.FormService

      • getFormInstanceModelById

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelById​(java.lang.String formDefinitionId,
                                                                       java.lang.String taskId,
                                                                       java.lang.String processInstanceId,
                                                                       java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                       java.lang.String tenantId,
                                                                       boolean fallbackToDefaultTenant)
        Specified by:
        getFormInstanceModelById in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKey

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKey​(java.lang.String formDefinitionKey,
                                                                        java.lang.String taskId,
                                                                        java.lang.String processInstanceId,
                                                                        java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormInstanceModelByKey in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKey

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKey​(java.lang.String formDefinitionKey,
                                                                        java.lang.String taskId,
                                                                        java.lang.String processInstanceId,
                                                                        java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                        java.lang.String tenantId,
                                                                        boolean fallbackToDefaultTenant)
        Specified by:
        getFormInstanceModelByKey in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKeyAndParentDeploymentId

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey,
                                                                                             java.lang.String parentDeploymentId,
                                                                                             java.lang.String taskId,
                                                                                             java.lang.String processInstanceId,
                                                                                             java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormInstanceModelByKeyAndParentDeploymentId in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKeyAndParentDeploymentId

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentId​(java.lang.String formDefinitionKey,
                                                                                             java.lang.String parentDeploymentId,
                                                                                             java.lang.String taskId,
                                                                                             java.lang.String processInstanceId,
                                                                                             java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                                             java.lang.String tenantId,
                                                                                             boolean fallbackToDefaultTenant)
        Specified by:
        getFormInstanceModelByKeyAndParentDeploymentId in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKeyAndScopeId

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndScopeId​(java.lang.String formDefinitionKey,
                                                                                  java.lang.String scopeId,
                                                                                  java.lang.String scopeType,
                                                                                  java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormInstanceModelByKeyAndScopeId in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKeyAndScopeId

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndScopeId​(java.lang.String formDefinitionKey,
                                                                                  java.lang.String scopeId,
                                                                                  java.lang.String scopeType,
                                                                                  java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                                  java.lang.String tenantId,
                                                                                  boolean fallbackToDefaultTenant)
        Specified by:
        getFormInstanceModelByKeyAndScopeId in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId​(java.lang.String formDefinitionKey,
                                                                                                       java.lang.String parentDeploymentId,
                                                                                                       java.lang.String scopeId,
                                                                                                       java.lang.String scopeType,
                                                                                                       java.util.Map<java.lang.String,​java.lang.Object> variables)
        Specified by:
        getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId in interface org.flowable.form.api.FormService

      • getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId

        public org.flowable.form.api.FormInstanceInfo getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId​(java.lang.String formDefinitionKey,
                                                                                                       java.lang.String parentDeploymentId,
                                                                                                       java.lang.String scopeId,
                                                                                                       java.lang.String scopeType,
                                                                                                       java.util.Map<java.lang.String,​java.lang.Object> variables,
                                                                                                       java.lang.String tenantId,
                                                                                                       boolean fallbackToDefaultTenant)
        Specified by:
        getFormInstanceModelByKeyAndParentDeploymentIdAndScopeId in interface org.flowable.form.api.FormService

      • getFormInstanceValues

        public byte[] getFormInstanceValues​(java.lang.String formInstanceId)
        Specified by:
        getFormInstanceValues in interface org.flowable.form.api.FormService

      • createFormInstanceQuery

        public org.flowable.form.api.FormInstanceQuery createFormInstanceQuery()
        Specified by:
        createFormInstanceQuery in interface org.flowable.form.api.FormService

      • deleteFormInstance

        public void deleteFormInstance​(java.lang.String formInstanceId)
        Specified by:
        deleteFormInstance in interface org.flowable.form.api.FormService

      • deleteFormInstancesByFormDefinition

        public void deleteFormInstancesByFormDefinition​(java.lang.String formDefinitionId)
        Specified by:
        deleteFormInstancesByFormDefinition in interface org.flowable.form.api.FormService

      • deleteFormInstancesByProcessDefinition

        public void deleteFormInstancesByProcessDefinition​(java.lang.String processDefinitionId)
        Specified by:
        deleteFormInstancesByProcessDefinition in interface org.flowable.form.api.FormService

      • deleteFormInstancesByScopeDefinition

        public void deleteFormInstancesByScopeDefinition​(java.lang.String scopeDefinitionId)
        Specified by:
        deleteFormInstancesByScopeDefinition in interface org.flowable.form.api.FormService

      • getSavedFormVariables

        public java.util.Map<java.lang.String,​java.lang.Object> getSavedFormVariables​(org.flowable.form.api.FormInstance formInstance)

      • getStartFormVariables

        public java.util.Map<java.lang.String,​java.lang.Object> getStartFormVariables​(java.lang.String processInstanceId,
                                                                                    java.lang.String scopeId)