io.jmix.bpmui.processform

Interface ProcessFormContext

All Known Implementing Classes:

ProcessFormContextImpl

public interface ProcessFormContext

Method Summary

Modifier and Type	Method and Description
FormData	getFormData()
org.flowable.engine.repository.ProcessDefinition	getProcessDefinition()
org.flowable.task.api.Task	getTask()
ProcessStarting	processStarting() Returns a process starting builder.
void	setFormData(FormData formData)
void	setFrameOwner(io.jmix.ui.screen.FrameOwner frameOwner)
void	setProcessDefinition(org.flowable.engine.repository.ProcessDefinition processDefinition)
void	setTask(org.flowable.task.api.Task task)
TaskClaiming	taskClaiming() Returns a task claiming builder.
TaskCompletion	taskCompletion() Returns a task completion builder.

Method Detail

setFrameOwner

void setFrameOwner(io.jmix.ui.screen.FrameOwner frameOwner)

getProcessDefinition

org.flowable.engine.repository.ProcessDefinition getProcessDefinition()

setProcessDefinition

void setProcessDefinition(org.flowable.engine.repository.ProcessDefinition processDefinition)

getTask

org.flowable.task.api.Task getTask()

setTask

void setTask(org.flowable.task.api.Task task)

getFormData

FormData getFormData()

setFormData

void setFormData(FormData formData)

processStarting

ProcessStarting processStarting()

Returns a process starting builder. A returned object contains an info about the process definition that must be started.

Usage example:

 processFormContext.processStarting()
    .withBusinessKey("order-123")
    .addProcessVariable("order", order)
    .start();
 

taskClaiming

TaskClaiming taskClaiming()

Returns a task claiming builder. A returned object contains an info about the task to be claimed

Usage example:

 processFormContext.taskClaiming()
    .claim();
 

taskCompletion

TaskCompletion taskCompletion()

Returns a task completion builder. A returned object contains an info about the task to be completed

Usage example:

 processFormContext.taskCompletion()
    .withOutcome("approve")
    .addProcessVariable("order", order)
    .complete();