public class FormServiceImpl extends ServiceImpl implements FormService
commandExecutor, processEngineConfiguration| Constructor and Description |
|---|
FormServiceImpl() |
| Modifier and Type | Method and 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,
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,
String businessKey,
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.
|
getCommandExecutor, setCommandExecutorpublic Object getRenderedStartForm(String processDefinitionId)
FormServicegetRenderedStartForm in interface FormServicepublic Object getRenderedStartForm(String processDefinitionId, String engineName)
FormServicegetRenderedStartForm in interface FormServicepublic Object getRenderedTaskForm(String taskId)
FormServicegetRenderedTaskForm in interface FormServicepublic Object getRenderedTaskForm(String taskId, String engineName)
FormServicegetRenderedTaskForm in interface FormServicepublic StartFormData getStartFormData(String processDefinitionId)
FormServicegetStartFormData in interface FormServicepublic TaskFormData getTaskFormData(String taskId)
FormServicegetTaskFormData in interface FormServicepublic ProcessInstance submitStartFormData(String processDefinitionId, Map<String,String> properties)
FormServicesubmitStartFormData in interface FormServicepublic ProcessInstance submitStartFormData(String processDefinitionId, String businessKey, Map<String,String> properties)
FormServiceProcessInstanceQuery.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.submitStartFormData in interface FormServiceprocessDefinitionId - 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.public void submitTaskFormData(String taskId, Map<String,String> properties)
FormServicesubmitTaskFormData in interface FormServicepublic String getStartFormKey(String processDefinitionId)
FormServicegetStartFormKey in interface FormServicepublic String getTaskFormKey(String processDefinitionId, String taskDefinitionKey)
FormServiceTask instances returned by any
TaskQuery.getTaskFormKey in interface FormServicepublic void saveFormData(String taskId, Map<String,String> properties)
FormServicesaveFormData in interface FormServiceCopyright © 2016 Alfresco. All rights reserved.