public interface UserRequestHandler
Modifier and Type | Method and Description |
---|---|
void |
cancel(org.flowable.engine.runtime.ProcessInstance procInst,
String reason)
Cancel a running user request.
|
void |
cancelByProcessDefinition(String processDefinitionId)
Cancel all running user requests for the given process definition id.
|
void |
cancelByUser(AnyLifecycleEvent<Any<?>> event)
Cancel all running user requests for the user in the given delete event.
|
UserRequestForm |
claimForm(String taskId)
Claim a form for a given object.
|
UserRequestForm |
getForm(String userKey,
String taskId)
Get the form matching the provided task id.
|
Pair<Integer,List<UserRequestForm>> |
getForms(String userKey,
int page,
int size,
List<OrderByClause> orderByClauses)
Get the forms matching the provided parameters.
|
Pair<Integer,List<UserRequest>> |
getUserRequests(String userKey,
int page,
int size,
List<OrderByClause> orderByClauses)
Get the running user requests matching the provided parameters.
|
Pair<org.flowable.engine.runtime.ProcessInstance,String> |
parse(String executionId)
Parses the given execution id to find matching user request and owner.
|
UserRequest |
start(String bpmnProcess,
User user,
WorkflowTaskExecInput inputVariables)
Starts a new user request, for the given BPMN process and user.
|
UserWorkflowResult<UserPatch> |
submitForm(UserRequestForm form)
Submit a form.
|
UserRequestForm |
unclaimForm(String taskId)
Unclaim a form for a given object.
|
Pair<Integer,List<UserRequest>> getUserRequests(String userKey, int page, int size, List<OrderByClause> orderByClauses)
userKey
- user key (optional)page
- result pagesize
- items per pageorderByClauses
- sort conditionsUserRequest start(String bpmnProcess, User user, WorkflowTaskExecInput inputVariables)
bpmnProcess
- BPMN processuser
- userinputVariables
- variablesPair<org.flowable.engine.runtime.ProcessInstance,String> parse(String executionId)
executionId
- execution idvoid cancel(org.flowable.engine.runtime.ProcessInstance procInst, String reason)
procInst
- process instance for user requestreason
- reason to cancel the user requestvoid cancelByProcessDefinition(String processDefinitionId)
processDefinitionId
- process definition id@TransactionalEventListener void cancelByUser(AnyLifecycleEvent<Any<?>> event)
event
- delete eventUserRequestForm getForm(String userKey, String taskId)
userKey
- user keytaskId
- task idPair<Integer,List<UserRequestForm>> getForms(String userKey, int page, int size, List<OrderByClause> orderByClauses)
userKey
- user key (optional)page
- result pagesize
- items per pageorderByClauses
- sort conditionsUserRequestForm claimForm(String taskId)
taskId
- Workflow task to which the form is associatedUserRequestForm unclaimForm(String taskId)
taskId
- Workflow task to which the form is associatedUserWorkflowResult<UserPatch> submitForm(UserRequestForm form)
form
- to be submittedCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.