org.camunda.bpm.engine

Interface FormService

All Known Implementing Classes:

FormServiceImpl

public interface FormService

Access to form data and rendered forms for starting new process instances and completing tasks.

Author:

Tom Baeyens, Falko Menge (camunda)

Method Summary

Modifier and Type	Method and Description
InputStream	getDeployedStartForm(String processDefinitionId) Retrieves a deployed start form for a process definition with a given id.
InputStream	getDeployedTaskForm(String taskId) Retrieves a deployed task form for a task with a given id.
Object	getRenderedStartForm(String processDefinitionId) Rendered form generated by the default build-in form engine for starting a new process instance.
Object	getRenderedStartForm(String processDefinitionId, String formEngineName) Rendered form generated by the given build-in form engine for starting a new process instance.
Object	getRenderedTaskForm(String taskId) Rendered form generated by the default build-in form engine for completing a task.
Object	getRenderedTaskForm(String taskId, String formEngineName) Rendered form generated by the given build-in form engine for completing a task.
StartFormData	getStartFormData(String processDefinitionId) Retrieves all data necessary for rendering a form to start a new process instance.
String	getStartFormKey(String processDefinitionId) Retrieves a user defined reference to a start form.
org.camunda.bpm.engine.variable.VariableMap	getStartFormVariables(String processDefinitionId) Retrieves a list of all variables for rendering a start from.
org.camunda.bpm.engine.variable.VariableMap	getStartFormVariables(String processDefinitionId, Collection<String> formVariables, boolean deserializeObjectValues) Retrieves a list of requested variables for rendering a start from.
TaskFormData	getTaskFormData(String taskId) Retrieves all data necessary for rendering a form to complete a task.
String	getTaskFormKey(String processDefinitionId, String taskDefinitionKey) Retrieves a user defined reference to a task form.
org.camunda.bpm.engine.variable.VariableMap	getTaskFormVariables(String taskId) Retrieves a list of all variables for rendering a task form.
org.camunda.bpm.engine.variable.VariableMap	getTaskFormVariables(String taskId, Collection<String> formVariables, boolean deserializeObjectValues) Retrieves a list of requested variables for rendering a task form.
ProcessInstance	submitStartForm(String processDefinitionId, Map<String,Object> properties) Start a new process instance with the user data that was entered as properties in a start form.
ProcessInstance	submitStartForm(String processDefinitionId, String businessKey, Map<String,Object> properties) Start a new process instance with the user data that was entered as properties in a start form.
ProcessInstance	submitStartFormData(String processDefinitionId, Map<String,String> properties) Deprecated. use submitStartForm(String, Map)
ProcessInstance	submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties) Deprecated. use submitStartForm(String, String, Map)
void	submitTaskForm(String taskId, Map<String,Object> properties) Completes a task with the user data that was entered as properties in a task form.
void	submitTaskFormData(String taskId, Map<String,String> properties) Deprecated. use submitTaskForm(String, Map)
org.camunda.bpm.engine.variable.VariableMap	submitTaskFormWithVariablesInReturn(String taskId, Map<String,Object> properties, boolean deserializeValues) Completes a task with the user data that was entered as properties in a task form.

Method Detail

getStartFormData

StartFormData getStartFormData(String processDefinitionId)

Retrieves all data necessary for rendering a form to start a new process instance. This can be used to perform rendering of the forms outside of the process engine.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

getRenderedStartForm

Object getRenderedStartForm(String processDefinitionId)

Rendered form generated by the default build-in form engine for starting a new process instance.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

getRenderedStartForm

Object getRenderedStartForm(String processDefinitionId,
                            String formEngineName)

Rendered form generated by the given build-in form engine for starting a new process instance.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

submitStartFormData

@Deprecated
ProcessInstance submitStartFormData(String processDefinitionId,
                                                Map<String,String> properties)

Deprecated. use submitStartForm(String, Map)

submitStartForm

ProcessInstance submitStartForm(String processDefinitionId,
                                Map<String,Object> properties)

Start a new process instance with the user data that was entered as properties in a start form.

Throws:

AuthorizationException - If the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

submitStartFormData

@Deprecated
ProcessInstance submitStartFormData(String processDefinitionId,
                                                String businessKey,
                                                Map<String,String> properties)

Deprecated. use submitStartForm(String, String, Map)

submitStartForm

ProcessInstance submitStartForm(String processDefinitionId,
                                String businessKey,
                                Map<String,Object> properties)

Start a new process instance with the user data that was entered as properties in a start form. A business key can be provided to associate the process instance with a certain identifier that has a clear business meaning. For example in an order process, the business key could be an order id. This business key can then be used to easily look up that process instance , see ProcessInstanceQuery.processInstanceBusinessKey(String). Providing such a business key is definitely a best practice. Note that a business key MUST be unique for the given process definition. Process instance from different process definition are allowed to have the same business key.

Parameters:

processDefinitionId - the id of the process definition, cannot be null.

businessKey - a key that uniquely identifies the process instance in the context or the given process definition.

properties - the properties to pass, can be null.

Throws:

AuthorizationException - If the user has no Permissions.CREATE permission on Resources.PROCESS_INSTANCE and no Permissions.CREATE_INSTANCE permission on Resources.PROCESS_DEFINITION.

getTaskFormData

TaskFormData getTaskFormData(String taskId)

Retrieves all data necessary for rendering a form to complete a task. This can be used to perform rendering of the forms outside of the process engine.

Throws:

AuthorizationException -

In case of standalone tasks:

if the user has no Permissions.READ permission on Resources.TASK or

if the user has no TaskPermissions#READ_VARIABLE permission on Resources.TASK

In case the task is part of a running process instance:

if the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION if the user has TaskPermissions#READ_VARIABLE permission on Resources.TASK or no ProcessDefinitionPermissions#READ_TASK_VARIABLE permission on Resources.PROCESS_DEFINITION when this config is enabled

getRenderedTaskForm

Object getRenderedTaskForm(String taskId)

Rendered form generated by the default build-in form engine for completing a task.

Throws:

AuthorizationException -

In case of standalone tasks:

if the user has no Permissions.READ permission on Resources.TASK or

if the user has no TaskPermissions#READ_VARIABLE permission on Resources.TASK when this config is enabled

In case the task is part of a running process instance:

if the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION if the user has TaskPermissions#READ_VARIABLE permission on Resources.TASK or no ProcessDefinitionPermissions#READ_TASK_VARIABLE permission on Resources.PROCESS_DEFINITION when this config is enabled

getRenderedTaskForm

Object getRenderedTaskForm(String taskId,
                           String formEngineName)

Rendered form generated by the given build-in form engine for completing a task.

Throws:

AuthorizationException -

In case of standalone tasks:

if the user has no Permissions.READ permission on Resources.TASK or

if the user has no TaskPermissions#READ_VARIABLE permission on Resources.TASK when this config is enabled

In case the task is part of a running process instance:

if the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION if the user has TaskPermissions#READ_VARIABLE permission on Resources.TASK or no ProcessDefinitionPermissions#READ_TASK_VARIABLE permission on Resources.PROCESS_DEFINITION when this config is enabled

submitTaskFormData

@Deprecated
void submitTaskFormData(String taskId,
                                    Map<String,String> properties)

Deprecated. use submitTaskForm(String, Map)

submitTaskForm

void submitTaskForm(String taskId,
                    Map<String,Object> properties)

Completes a task with the user data that was entered as properties in a task form.

Parameters:

taskId -

properties -

Throws:

AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION.

submitTaskFormWithVariablesInReturn

org.camunda.bpm.engine.variable.VariableMap submitTaskFormWithVariablesInReturn(String taskId,
                                                                                Map<String,Object> properties,
                                                                                boolean deserializeValues)

Completes a task with the user data that was entered as properties in a task form.

Parameters:

taskId -

properties -

deserializeValues - if false, returned SerializableValues will not be deserialized (unless they are passed into this method as a deserialized value or if the BPMN process triggers deserialization)

Returns:

a map of process variables

Throws:

AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION.

getStartFormVariables

org.camunda.bpm.engine.variable.VariableMap getStartFormVariables(String processDefinitionId)

Retrieves a list of all variables for rendering a start from. The method takes into account FormData specified for the start event. This allows defining default values for form fields.

Parameters:

processDefinitionId - the id of the process definition for which the start form should be retrieved.

Returns:

a map of VariableInstances.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

getStartFormVariables

org.camunda.bpm.engine.variable.VariableMap getStartFormVariables(String processDefinitionId,
                                                                  Collection<String> formVariables,
                                                                  boolean deserializeObjectValues)

Retrieves a list of requested variables for rendering a start from. The method takes into account FormData specified for the start event. This allows defining default values for form fields.

Parameters:

processDefinitionId - the id of the process definition for which the start form should be retrieved.

formVariables - a Collection of the names of the variables to retrieve. Allows restricting the set of retrieved variables.

deserializeObjectValues - if false object values are not deserialized

Returns:

a map of VariableInstances.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

getTaskFormVariables

org.camunda.bpm.engine.variable.VariableMap getTaskFormVariables(String taskId)

Retrieves a list of all variables for rendering a task form. In addition to the task variables and process variables, the method takes into account FormData specified for the task. This allows defining default values for form fields.

A variable is resolved in the following order:

• First, the method collects all form fields and creates variable instances for the form fields.
• Next, the task variables are collected.
• Next, process variables from the parent scopes of the task are collected, until the process instance scope is reached.

Parameters:

taskId - the id of the task for which the variables should be retrieved.

Returns:

a map of VariableInstances.

Throws:

AuthorizationException -

In case of standalone tasks:

if the user has no Permissions.READ permission on Resources.TASK or

if the user has no TaskPermissions#READ_VARIABLE permission on Resources.TASK when this config is enabled

In case the task is part of a running process instance:

if the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION if the user has TaskPermissions#READ_VARIABLE permission on Resources.TASK or no ProcessDefinitionPermissions#READ_TASK_VARIABLE permission on Resources.PROCESS_DEFINITION when this config is enabled

getTaskFormVariables

org.camunda.bpm.engine.variable.VariableMap getTaskFormVariables(String taskId,
                                                                 Collection<String> formVariables,
                                                                 boolean deserializeObjectValues)

Retrieves a list of requested variables for rendering a task form. In addition to the task variables and process variables, the method takes into account FormData specified for the task. This allows defining default values for form fields.

A variable is resolved in the following order:

• First, the method collects all form fields and creates variable instances for the form fields.
• Next, the task variables are collected.
• Next, process variables from the parent scopes of the task are collected, until the process instance scope is reached.

Parameters:

taskId - the id of the task for which the variables should be retrieved.

formVariables - a Collection of the names of the variables to retrieve. Allows restricting the set of retrieved variables.

deserializeObjectValues - if false object values are not deserialized

Returns:

a map of VariableInstances.

Throws:

AuthorizationException -

In case of standalone tasks:

if the user has no Permissions.READ permission on Resources.TASK or

if the user has no TaskPermissions#READ_VARIABLE permission on Resources.TASK when this config is enabled

In case the task is part of a running process instance:

if the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION if the user has TaskPermissions#READ_VARIABLE permission on Resources.TASK or no ProcessDefinitionPermissions#READ_TASK_VARIABLE permission on Resources.PROCESS_DEFINITION when this config is enabled

getStartFormKey

String getStartFormKey(String processDefinitionId)

Retrieves a user defined reference to a start form. In the Explorer app, it is assumed that the form key specifies a resource in the deployment, which is the template for the form. But users are free to use this property differently.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

getTaskFormKey

String getTaskFormKey(String processDefinitionId,
                      String taskDefinitionKey)

Retrieves a user defined reference to a task form. In the Explorer app, it is assumed that the form key specifies a resource in the deployment, which is the template for the form. But users are free to use this property differently. Both arguments can be obtained from Task instances returned by any TaskQuery.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

getDeployedStartForm

InputStream getDeployedStartForm(String processDefinitionId)

Retrieves a deployed start form for a process definition with a given id.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.PROCESS_DEFINITION.

NotFoundException - If the start form cannot be found.

BadUserRequestException - If the start form key has wrong format ("embedded:deployment:" or "deployment:" required).

getDeployedTaskForm

InputStream getDeployedTaskForm(String taskId)

Retrieves a deployed task form for a task with a given id.

Throws:

AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK.

NotFoundException - If the task form cannot be found.

BadUserRequestException - If the task form key has wrong format ("embedded:deployment:" or "deployment:" required).