org.activiti.form.api

Interface FormService

public interface FormService

Author:

Tijs Rademakers

Method Summary

Modifier and Type	Method and Description
void	completeForm(FormDefinition formDefinition)
SubmittedFormQuery	createSubmittedFormQuery()
CompletedFormDefinition	getCompletedTaskFormDefinitionById(String formId, String taskId, String processInstanceId, Map<String,Object> variables)
CompletedFormDefinition	getCompletedTaskFormDefinitionById(String formId, String taskId, String processInstanceId, Map<String,Object> variables, String tenantId)
CompletedFormDefinition	getCompletedTaskFormDefinitionByKey(String formDefinitionKey, String taskId, String processInstanceId, Map<String,Object> variables)
CompletedFormDefinition	getCompletedTaskFormDefinitionByKey(String formDefinitionKey, String taskId, String processInstanceId, Map<String,Object> variables, String tenantId)
CompletedFormDefinition	getCompletedTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, String processInstanceId, Map<String,Object> variables)
CompletedFormDefinition	getCompletedTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, String processInstanceId, Map<String,Object> variables, String tenantId)
FormDefinition	getTaskFormDefinitionById(String formId, String processInstanceId, Map<String,Object> variables)
FormDefinition	getTaskFormDefinitionById(String formId, String processInstanceId, Map<String,Object> variables, String tenantId)
FormDefinition	getTaskFormDefinitionByKey(String formDefinitionKey, String processInstanceId, Map<String,Object> variables)
FormDefinition	getTaskFormDefinitionByKey(String formDefinitionKey, String processInstanceId, Map<String,Object> variables, String tenantId)
FormDefinition	getTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String processInstanceId, Map<String,Object> variables)
FormDefinition	getTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String processInstanceId, Map<String,Object> variables, String tenantId)
Map<String,Object>	getVariablesFromFormSubmission(FormDefinition formDefinition, Map<String,Object> values, String outcome)
SubmittedForm	storeSubmittedForm(Map<String,Object> values, FormDefinition formDefinition, String taskId, String processInstanceId) Store the submitted form values.

Method Detail

completeForm

void completeForm(FormDefinition formDefinition)

getVariablesFromFormSubmission

Map<String,Object> getVariablesFromFormSubmission(FormDefinition formDefinition,
                                                  Map<String,Object> values,
                                                  String outcome)

Parameters:

definition - 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 activiti engine, based on the filled in values and selected outcome.

Throws:

FormValidationException - when a submitted value is not valid or a required value is missing.

storeSubmittedForm

SubmittedForm storeSubmittedForm(Map<String,Object> values,
                                 FormDefinition formDefinition,
                                 String taskId,
                                 String processInstanceId)

Store the submitted form values.

Parameters:

form - form instance of the submitted form

taskId - task instance id of the completed task

processInstanceId - process instance id of the completed task

valuesNode - json node with the values of the

getTaskFormDefinitionById

FormDefinition getTaskFormDefinitionById(String formId,
                                         String processInstanceId,
                                         Map<String,Object> variables)

getTaskFormDefinitionById

FormDefinition getTaskFormDefinitionById(String formId,
                                         String processInstanceId,
                                         Map<String,Object> variables,
                                         String tenantId)

getTaskFormDefinitionByKey

FormDefinition getTaskFormDefinitionByKey(String formDefinitionKey,
                                          String processInstanceId,
                                          Map<String,Object> variables)

getTaskFormDefinitionByKey

FormDefinition getTaskFormDefinitionByKey(String formDefinitionKey,
                                          String processInstanceId,
                                          Map<String,Object> variables,
                                          String tenantId)

getTaskFormDefinitionByKeyAndParentDeploymentId

FormDefinition getTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey,
                                                               String parentDeploymentId,
                                                               String processInstanceId,
                                                               Map<String,Object> variables)

getTaskFormDefinitionByKeyAndParentDeploymentId

FormDefinition getTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey,
                                                               String parentDeploymentId,
                                                               String processInstanceId,
                                                               Map<String,Object> variables,
                                                               String tenantId)

getCompletedTaskFormDefinitionById

CompletedFormDefinition getCompletedTaskFormDefinitionById(String formId,
                                                           String taskId,
                                                           String processInstanceId,
                                                           Map<String,Object> variables)

getCompletedTaskFormDefinitionById

CompletedFormDefinition getCompletedTaskFormDefinitionById(String formId,
                                                           String taskId,
                                                           String processInstanceId,
                                                           Map<String,Object> variables,
                                                           String tenantId)

getCompletedTaskFormDefinitionByKey

CompletedFormDefinition getCompletedTaskFormDefinitionByKey(String formDefinitionKey,
                                                            String taskId,
                                                            String processInstanceId,
                                                            Map<String,Object> variables)

getCompletedTaskFormDefinitionByKey

CompletedFormDefinition getCompletedTaskFormDefinitionByKey(String formDefinitionKey,
                                                            String taskId,
                                                            String processInstanceId,
                                                            Map<String,Object> variables,
                                                            String tenantId)

getCompletedTaskFormDefinitionByKeyAndParentDeploymentId

CompletedFormDefinition getCompletedTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey,
                                                                                 String parentDeploymentId,
                                                                                 String taskId,
                                                                                 String processInstanceId,
                                                                                 Map<String,Object> variables)

getCompletedTaskFormDefinitionByKeyAndParentDeploymentId

CompletedFormDefinition getCompletedTaskFormDefinitionByKeyAndParentDeploymentId(String formDefinitionKey,
                                                                                 String parentDeploymentId,
                                                                                 String taskId,
                                                                                 String processInstanceId,
                                                                                 Map<String,Object> variables,
                                                                                 String tenantId)

createSubmittedFormQuery

SubmittedFormQuery createSubmittedFormQuery()