Class FormServiceImpl

java.lang.Object
org.flowable.common.engine.impl.service.CommonServiceImpl<FormEngineConfiguration>
org.flowable.common.engine.impl.service.CommonEngineServiceImpl<FormEngineConfiguration>
com.flowable.form.engine.impl.FormServiceImpl
All Implemented Interfaces:
CoreFormService, org.flowable.form.api.FormService

public class FormServiceImpl extends org.flowable.common.engine.impl.service.CommonEngineServiceImpl<FormEngineConfiguration> implements CoreFormService
Author:
Tijs Rademakers
  • Constructor Details

    • FormServiceImpl

      public FormServiceImpl()
  • Method Details

    • getVariablesFromFormSubmission

      public Map<String,Object> getVariablesFromFormSubmission(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, org.flowable.form.api.FormInfo formInfo, Map<String,Object> values)
    • validateFormFields

      public void validateFormFields(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, org.flowable.form.api.FormInfo formInfo, Map<String,Object> values)
      Specified by:
      validateFormFields in interface org.flowable.form.api.FormService
    • getVariablesFromFormSubmission

      public Map<String,Object> getVariablesFromFormSubmission(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, org.flowable.form.api.FormInfo formInfo, Map<String,Object> values, String outcome)
      Specified by:
      getVariablesFromFormSubmission in interface org.flowable.form.api.FormService
    • createFormInstance

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

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

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

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

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

      public org.flowable.form.api.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 org.flowable.form.api.FormService
    • getFormModelWithVariablesById

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public Map<String,Object> filterFormValues(String elementId, String elementType, String scopeDefinitionId, String scopeType, Map<String,Object> formValues)
      Description copied from interface: CoreFormService
      Filter the form values based on the defined output mappings.
      Specified by:
      filterFormValues in interface CoreFormService
      Parameters:
      elementId - element id to which the form is attached to.
      elementType - element type to which the form is attached to.
      scopeDefinitionId - definition id to which the form is attached to.
      scopeType - scope type to which the form is attached to.
      Returns:
      the filtered values.
    • getFormInstanceValues

      public byte[] getFormInstanceValues(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(String formInstanceId)
      Specified by:
      deleteFormInstance in interface org.flowable.form.api.FormService
    • deleteFormInstancesByFormDefinition

      public void deleteFormInstancesByFormDefinition(String formDefinitionId)
      Specified by:
      deleteFormInstancesByFormDefinition in interface org.flowable.form.api.FormService
    • deleteFormInstancesByProcessDefinition

      public void deleteFormInstancesByProcessDefinition(String processDefinitionId)
      Specified by:
      deleteFormInstancesByProcessDefinition in interface org.flowable.form.api.FormService
    • deleteFormInstancesByScopeDefinition

      public void deleteFormInstancesByScopeDefinition(String scopeDefinitionId)
      Specified by:
      deleteFormInstancesByScopeDefinition in interface org.flowable.form.api.FormService
    • getSavedFormVariables

      public Map<String,Object> getSavedFormVariables(org.flowable.form.api.FormInstance formInstance)
    • getStartFormVariables

      public Map<String,Object> getStartFormVariables(String processInstanceId, String scopeId)
    • bulkDeleteFormInstancesByProcessInstanceIds

      public void bulkDeleteFormInstancesByProcessInstanceIds(Collection<String> processInstanceIds)
    • bulkDeleteFormInstancesByScopeIdsAndScopeType

      public void bulkDeleteFormInstancesByScopeIdsAndScopeType(Collection<String> scopeIds, String scopeType)