Package org.flowable.engine.impl

Class FormServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<ProcessEngineConfigurationImpl>

org.flowable.engine.impl.FormServiceImpl

All Implemented Interfaces:

FormService

public class FormServiceImpl
extends CommonEngineServiceImpl<ProcessEngineConfigurationImpl>
implements FormService

Author:

Tom Baeyens, Falko Menge (camunda)

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

Modifier and Type	Method	Description
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 engineName)	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 engineName)	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.
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.
void	saveFormData(String taskId, Map<String,String> properties)	Save the data that was entered as properties in a task form.
ProcessInstance	submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> 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)	Start a new process instance with the user data that was entered as properties in a start form.
void	submitTaskFormData(String taskId, Map<String,String> properties)	Completes a task with the user data that was entered as properties in a task form.

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

getRenderedStartForm

public Object getRenderedStartForm(String processDefinitionId)

Description copied from interface: FormService

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

Specified by:

getRenderedStartForm in interface FormService

getRenderedStartForm

public Object getRenderedStartForm(String processDefinitionId,
                                   String engineName)

Description copied from interface: FormService

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

Specified by:

getRenderedStartForm in interface FormService

getRenderedTaskForm

public Object getRenderedTaskForm(String taskId)

Description copied from interface: FormService

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

Specified by:

getRenderedTaskForm in interface FormService

getRenderedTaskForm

public Object getRenderedTaskForm(String taskId,
                                  String engineName)

Description copied from interface: FormService

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

Specified by:

getRenderedTaskForm in interface FormService

getStartFormData

public StartFormData getStartFormData(String processDefinitionId)

Description copied from interface: FormService

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.

Specified by:

getStartFormData in interface FormService

getTaskFormData

public TaskFormData getTaskFormData(String taskId)

Description copied from interface: FormService

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.

Specified by:

getTaskFormData in interface FormService

submitStartFormData

public ProcessInstance submitStartFormData(String processDefinitionId,
                                           Map<String,String> properties)

Description copied from interface: FormService

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

Specified by:

submitStartFormData in interface FormService

submitStartFormData

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

Description copied from interface: FormService

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.

Specified by:

submitStartFormData in interface FormService

Parameters:

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

businessKey - a key that identifies the process instance and can be used to retrieve the process instance later via the query API.

properties - the properties to pass, can be null.

submitTaskFormData

public void submitTaskFormData(String taskId,
                               Map<String,String> properties)

Description copied from interface: FormService

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

Specified by:

submitTaskFormData in interface FormService

getStartFormKey

public String getStartFormKey(String processDefinitionId)

Description copied from interface: FormService

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.

Specified by:

getStartFormKey in interface FormService

getTaskFormKey

public String getTaskFormKey(String processDefinitionId,
                             String taskDefinitionKey)

Description copied from interface: FormService

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.

Specified by:

getTaskFormKey in interface FormService

saveFormData

public void saveFormData(String taskId,
                         Map<String,String> properties)

Description copied from interface: FormService

Save the data that was entered as properties in a task form.

Specified by:

saveFormData in interface FormService