Uses of Class
org.flowable.form.api.FormInfo

Packages that use FormInfo

Package	Description
org.flowable.cmmn.api
org.flowable.cmmn.api.runtime
org.flowable.cmmn.engine.configurator.impl.process
org.flowable.cmmn.engine.impl
org.flowable.cmmn.engine.impl.behavior.impl
org.flowable.cmmn.engine.impl.cmd
org.flowable.cmmn.engine.impl.form
org.flowable.cmmn.engine.impl.process
org.flowable.cmmn.engine.impl.runtime
org.flowable.cmmn.engine.interceptor
org.flowable.cmmn.rest.service.api
org.flowable.cmmn.rest.service.api.repository
org.flowable.engine	Public API of the Flowable engine. Typical usage of the API starts by the creation of a ProcessEngineConfiguration (typically based on a configuration file), from which a ProcessEngine can be obtained. Through the services obtained from such a ProcessEngine, BPM and workflow operation can be executed: RepositoryService: Manages Deployments. RuntimeService: For starting and searching ProcessInstances. TaskService: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks. IdentityService: Used for managing users, groups and the relations between them. ManagementService: Exposes engine administration and maintenance operations, which have no relation to the runtime exection of business processes. HistoryService: Exposes information about ongoing and past process instances. FormService: Access to form data and rendered forms for starting new process instances and completing tasks.
org.flowable.engine.impl	API implementation classes, which shouldn't directly be used by end-users.
org.flowable.engine.impl.cmd
org.flowable.engine.impl.formhandler
org.flowable.engine.impl.runtime
org.flowable.engine.interceptor
org.flowable.engine.runtime	Classes related to the RuntimeService.
org.flowable.form.api
org.flowable.rest.service.api
org.flowable.rest.service.api.repository

Uses of FormInfo in org.flowable.cmmn.api

Methods in org.flowable.cmmn.api that return FormInfo

Modifier and Type	Method	Description
FormInfo	CmmnRuntimeService.getStartFormModel(String caseDefinitionId, String caseInstanceId)	Gets a Form model instance of the start form of a specific case definition or case instance
FormInfo	CmmnTaskService.getTaskFormModel(String taskId)
FormInfo	CmmnTaskService.getTaskFormModel(String taskId, boolean ignoreVariables)

Uses of FormInfo in org.flowable.cmmn.api.runtime

Methods in org.flowable.cmmn.api.runtime with parameters of type FormInfo

Modifier and Type	Method	Description
PlanItemInstanceTransitionBuilder	PlanItemInstanceTransitionBuilder.childTaskFormVariables(Map<String,Object> variables, FormInfo formInfo, String outcome)	The form variables that should be used when creating a new 'child entity'.
PlanItemInstanceTransitionBuilder	PlanItemInstanceTransitionBuilder.formVariables(Map<String,Object> variables, FormInfo formInfo, String outcome)	The form variables that should be set before the transition is executed.

Uses of FormInfo in org.flowable.cmmn.engine.configurator.impl.process

Methods in org.flowable.cmmn.engine.configurator.impl.process with parameters of type FormInfo

Modifier and Type	Method	Description
String	DefaultProcessInstanceService.startProcessInstanceByKey(String processDefinitionKey, String predefinedProcessInstanceId, String stageInstanceId, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId, Map<String,Object> inParametersMap, String businessKey, Map<String,Object> variableFormVariables, FormInfo variableFormInfo, String variableFormOutcome)
String	DefaultProcessInstanceService.startProcessInstanceByKey(String processDefinitionKey, String predefinedProcessInstanceId, String planItemInstanceId, String stageInstanceId, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId, Map<String,Object> inParametersMap, String businessKey, Map<String,Object> variableFormVariables, FormInfo variableFormInfo, String variableFormOutcome)

Uses of FormInfo in org.flowable.cmmn.engine.impl

Methods in org.flowable.cmmn.engine.impl that return FormInfo

Modifier and Type	Method	Description
FormInfo	CmmnTaskServiceImpl.getTaskFormModel(String taskId)
FormInfo	CmmnTaskServiceImpl.getTaskFormModel(String taskId, boolean ignoreVariables)

Uses of FormInfo in org.flowable.cmmn.engine.impl.behavior.impl

Fields in org.flowable.cmmn.engine.impl.behavior.impl declared as FormInfo

Modifier and Type	Field	Description
protected FormInfo	ChildTaskActivityBehavior.VariableInfo.formInfo

Methods in org.flowable.cmmn.engine.impl.behavior.impl that return FormInfo

Modifier and Type	Method	Description
FormInfo	ChildTaskActivityBehavior.VariableInfo.getFormInfo()

Methods in org.flowable.cmmn.engine.impl.behavior.impl with parameters of type FormInfo

Modifier and Type	Method	Description
void	ChildTaskActivityBehavior.VariableInfo.setFormInfo(FormInfo formInfo)

Constructors in org.flowable.cmmn.engine.impl.behavior.impl with parameters of type FormInfo

Modifier	Constructor	Description
	VariableInfo(Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo)

Uses of FormInfo in org.flowable.cmmn.engine.impl.cmd

Fields in org.flowable.cmmn.engine.impl.cmd declared as FormInfo

Modifier and Type	Field	Description
protected FormInfo	StartPlanItemInstanceCmd.childTaskFormInfo
protected FormInfo	AbstractNeedsPlanItemInstanceCmd.formInfo

Methods in org.flowable.cmmn.engine.impl.cmd that return FormInfo

Modifier and Type	Method	Description
FormInfo	GetStartFormModelCmd.execute(CommandContext commandContext)
FormInfo	GetTaskFormModelCmd.execute(CommandContext commandContext)

Constructors in org.flowable.cmmn.engine.impl.cmd with parameters of type FormInfo

Modifier	Constructor	Description
	AbstractNeedsPlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables)
	CompleteStagePlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables, boolean force)
	DisablePlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables)
	EnablePlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables)
	StartPlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables, Map<String,Object> childTaskVariables, Map<String,Object> childTaskFormVariables, String childTaskFormOutcome, FormInfo childTaskFormInfo)
	TerminatePlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables)
	TriggerPlanItemInstanceCmd(String planItemInstanceId, Map<String,Object> variables, Map<String,Object> formVariables, String formOutcome, FormInfo formInfo, Map<String,Object> localVariables, Map<String,Object> transientVariables)

Uses of FormInfo in org.flowable.cmmn.engine.impl.form

Methods in org.flowable.cmmn.engine.impl.form with parameters of type FormInfo

Modifier and Type	Method	Description
void	DefaultFormFieldHandler.enrichFormFields(FormInfo formInfo)
void	DefaultFormFieldHandler.handleFormFieldsOnSubmit(FormInfo formInfo, String taskId, String processInstanceId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId)	When content is uploaded for a field, it is uploaded as a 'temporary related content'.

Uses of FormInfo in org.flowable.cmmn.engine.impl.process

Methods in org.flowable.cmmn.engine.impl.process with parameters of type FormInfo

Modifier and Type	Method	Description
String	ProcessInstanceService.startProcessInstanceByKey(String processDefinitionKey, String predefinedProcessInstanceId, String stageInstanceId, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId, Map<String,Object> inParametersMap, String businessKey, Map<String,Object> variableFormVariables, FormInfo variableFormInfo, String variableFormOutcome)	Starts a process instance without a reference to a plan item instance (i.e.
String	ProcessInstanceService.startProcessInstanceByKey(String processDefinitionKey, String predefinedProcessInstanceId, String planItemInstanceId, String stageInstanceId, String tenantId, Boolean fallbackToDefaultTenant, String parentDeploymentId, Map<String,Object> inParametersMap, String businessKey, Map<String,Object> variableFormVariables, FormInfo variableFormInfo, String variableFormOutcome)	Starts a process instance with a reference to a plan item instance (i.e.

Uses of FormInfo in org.flowable.cmmn.engine.impl.runtime

Fields in org.flowable.cmmn.engine.impl.runtime declared as FormInfo

Modifier and Type	Field	Description
protected FormInfo	PlanItemInstanceTransitionBuilderImpl.childTaskFormInfo
protected FormInfo	PlanItemInstanceTransitionBuilderImpl.formInfo

Methods in org.flowable.cmmn.engine.impl.runtime that return FormInfo

Modifier and Type	Method	Description
FormInfo	CmmnRuntimeServiceImpl.getStartFormModel(String caseDefinitionId, String caseInstanceId)
protected FormInfo	CaseInstanceHelperImpl.resolveFormInfo(Stage planModel, CaseDefinition caseDefinition, String tenantId, FormRepositoryService formRepositoryService, CmmnEngineConfiguration cmmnEngineConfiguration)

Methods in org.flowable.cmmn.engine.impl.runtime with parameters of type FormInfo

Modifier and Type	Method	Description
PlanItemInstanceTransitionBuilder	PlanItemInstanceTransitionBuilderImpl.childTaskFormVariables(Map<String,Object> variables, FormInfo formInfo, String outcome)
PlanItemInstanceTransitionBuilder	PlanItemInstanceTransitionBuilderImpl.formVariables(Map<String,Object> variables, FormInfo formInfo, String outcome)

Uses of FormInfo in org.flowable.cmmn.engine.interceptor

Methods in org.flowable.cmmn.engine.interceptor with parameters of type FormInfo

Modifier and Type	Method	Description
void	HumanTaskStateInterceptor.handleCompleteWithForm(TaskEntity task, FormInfo formInfo, String userId, String outcome, Map<String,Object> payload)

Uses of FormInfo in org.flowable.cmmn.rest.service.api

Methods in org.flowable.cmmn.rest.service.api with parameters of type FormInfo

Modifier and Type	Method	Description
String	CmmnFormHandlerRestApiInterceptor.convertHistoricTaskFormInfo(FormInfo formInfo, HistoricTaskInstance task)
String	CmmnFormHandlerRestApiInterceptor.convertStartFormInfo(FormInfo formInfo, CaseDefinition caseDefinition)
String	CmmnFormHandlerRestApiInterceptor.convertTaskFormInfo(FormInfo formInfo, Task task)

Constructors in org.flowable.cmmn.rest.service.api with parameters of type FormInfo

Modifier	Constructor	Description
	FormModelResponse(FormInfo formInfo)
	FormModelResponse(FormInfo formInfo, SimpleFormModel formModel)

Uses of FormInfo in org.flowable.cmmn.rest.service.api.repository

Methods in org.flowable.cmmn.rest.service.api.repository that return FormInfo

Modifier and Type	Method	Description
protected FormInfo	CaseDefinitionResource.getStartForm(FormRepositoryService formRepositoryService, CaseDefinition caseDefinition)

Uses of FormInfo in org.flowable.engine

Methods in org.flowable.engine that return FormInfo

Modifier and Type	Method	Description
FormInfo	RuntimeService.getStartFormModel(String processDefinitionId, String processInstanceId)	Gets a Form model instance of the start form of a specific process definition or process instance
FormInfo	TaskService.getTaskFormModel(String taskId)	Gets a Form model instance of the task form of a specific task
FormInfo	TaskService.getTaskFormModel(String taskId, boolean ignoreVariables)	Gets a Form model instance of the task form of a specific task without any variable handling

Uses of FormInfo in org.flowable.engine.impl

Methods in org.flowable.engine.impl that return FormInfo

Modifier and Type	Method	Description
FormInfo	RuntimeServiceImpl.getStartFormModel(String processDefinitionId, String processInstanceId)
FormInfo	TaskServiceImpl.getTaskFormModel(String taskId)
FormInfo	TaskServiceImpl.getTaskFormModel(String taskId, boolean ignoreVariables)

Uses of FormInfo in org.flowable.engine.impl.cmd

Fields in org.flowable.engine.impl.cmd declared as FormInfo

Modifier and Type	Field	Description
protected FormInfo	StartProcessInstanceCmd.extraFormInfo

Methods in org.flowable.engine.impl.cmd that return FormInfo

Modifier and Type	Method	Description
FormInfo	GetStartFormModelCmd.execute(CommandContext commandContext)
FormInfo	GetTaskFormModelCmd.execute(CommandContext commandContext)
protected FormInfo	StartProcessInstanceCmd.resolveFormInfo(StartEvent startEvent, ProcessDefinition processDefinition, FormRepositoryService formRepositoryService, ProcessEngineConfigurationImpl processEngineConfiguration)

Uses of FormInfo in org.flowable.engine.impl.formhandler

Methods in org.flowable.engine.impl.formhandler with parameters of type FormInfo

Modifier and Type	Method	Description
void	DefaultFormFieldHandler.enrichFormFields(FormInfo formInfo)
void	DefaultFormFieldHandler.handleFormFieldsOnSubmit(FormInfo formInfo, String taskId, String processInstanceId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId)	When content is uploaded for a field, it is uploaded as a 'temporary related content'.

Uses of FormInfo in org.flowable.engine.impl.runtime

Fields in org.flowable.engine.impl.runtime declared as FormInfo

Modifier and Type	Field	Description
protected FormInfo	ProcessInstanceBuilderImpl.extraFormInfo

Methods in org.flowable.engine.impl.runtime that return FormInfo

Modifier and Type	Method	Description
FormInfo	ProcessInstanceBuilderImpl.getExtraFormInfo()

Methods in org.flowable.engine.impl.runtime with parameters of type FormInfo

Modifier and Type	Method	Description
ProcessInstanceBuilder	ProcessInstanceBuilderImpl.formVariables(Map<String,Object> formVariables, FormInfo formInfo, String formOutcome)

Uses of FormInfo in org.flowable.engine.interceptor

Methods in org.flowable.engine.interceptor with parameters of type FormInfo

Modifier and Type	Method	Description
void	UserTaskStateInterceptor.handleCompleteWithForm(TaskEntity task, FormInfo formInfo, String userId, String outcome, Map<String,Object> payload)

Uses of FormInfo in org.flowable.engine.runtime

Methods in org.flowable.engine.runtime with parameters of type FormInfo

Modifier and Type	Method	Description
ProcessInstanceBuilder	ProcessInstanceBuilder.formVariables(Map<String,Object> formVariables, FormInfo formInfo, String formOutcome)	Start the process instance with the given form variables from the given formInfo.

Uses of FormInfo in org.flowable.form.api

Subclasses of FormInfo in org.flowable.form.api

Modifier and Type	Class	Description
class	FormInstanceInfo

Methods in org.flowable.form.api that return FormInfo

Modifier and Type	Method	Description
FormInfo	FormRepositoryService.getFormModelById(String formDefinitionId)
FormInfo	FormRepositoryService.getFormModelByKey(String formDefinitionKey)
FormInfo	FormRepositoryService.getFormModelByKey(String formDefinitionKey, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	FormRepositoryService.getFormModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId)
FormInfo	FormRepositoryService.getFormModelByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	FormService.getFormModelWithVariablesById(String formDefinitionId, String taskId, Map<String,Object> variables)
FormInfo	FormService.getFormModelWithVariablesById(String formDefinitionId, String taskId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	FormService.getFormModelWithVariablesByKey(String formDefinitionKey, String taskId, Map<String,Object> variables)
FormInfo	FormService.getFormModelWithVariablesByKey(String formDefinitionKey, String taskId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)
FormInfo	FormService.getFormModelWithVariablesByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, Map<String,Object> variables)
FormInfo	FormService.getFormModelWithVariablesByKeyAndParentDeploymentId(String formDefinitionKey, String parentDeploymentId, String taskId, Map<String,Object> variables, String tenantId, boolean fallbackToDefaultTenant)

Methods in org.flowable.form.api with parameters of type FormInfo

Modifier and Type	Method	Description
FormInstance	FormService.createFormInstance(Map<String,Object> variables, FormInfo formInfo, String taskId, String processInstanceId, String processDefinitionId, String tenantId, String outcome)	Store the submitted form values.
FormInstance	FormService.createFormInstanceWithScopeId(Map<String,Object> variables, FormInfo formInfo, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
void	FormFieldHandler.enrichFormFields(FormInfo formInfo)
Map<String,Object>	FormService.getVariablesFromFormSubmission(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, FormInfo formInfo, Map<String,Object> values, String outcome)
void	FormFieldHandler.handleFormFieldsOnSubmit(FormInfo formInfo, String taskId, String processInstanceId, String scopeId, String scopeType, Map<String,Object> variables, String tenantId)
FormInstance	FormService.saveFormInstance(Map<String,Object> variables, FormInfo formInfo, String taskId, String processInstanceId, String processDefinitionId, String tenantId, String outcome)
FormInstance	FormService.saveFormInstanceWithScopeId(Map<String,Object> variables, FormInfo formInfo, String taskId, String scopeId, String scopeType, String scopeDefinitionId, String tenantId, String outcome)
void	FormService.validateFormFields(String elementId, String elementType, String scopeId, String scopeDefinitionId, String scopeType, FormInfo formInfo, Map<String,Object> values)	Apply validation restrictions on the submitted variables

Uses of FormInfo in org.flowable.rest.service.api

Methods in org.flowable.rest.service.api with parameters of type FormInfo

Modifier and Type	Method	Description
String	FormHandlerRestApiInterceptor.convertHistoricTaskFormInfo(FormInfo formInfo, HistoricTaskInstance task)
String	FormHandlerRestApiInterceptor.convertStartFormInfo(FormInfo formInfo, ProcessDefinition processDefinition)
String	FormHandlerRestApiInterceptor.convertTaskFormInfo(FormInfo formInfo, Task task)

Constructors in org.flowable.rest.service.api with parameters of type FormInfo

Modifier	Constructor	Description
	FormModelResponse(FormInfo formInfo)
	FormModelResponse(FormInfo formInfo, SimpleFormModel formModel)

Uses of FormInfo in org.flowable.rest.service.api.repository

Methods in org.flowable.rest.service.api.repository that return FormInfo

Modifier and Type	Method	Description
protected FormInfo	ProcessDefinitionResource.getStartForm(FormRepositoryService formRepositoryService, ProcessDefinition processDefinition)