Package io.camunda.zeebe.model.bpmn.builder

Class AbstractUserTaskBuilder<B extends AbstractUserTaskBuilder<B>>

java.lang.Object

io.camunda.zeebe.model.bpmn.builder.AbstractBpmnModelElementBuilder<B,UserTask>

io.camunda.zeebe.model.bpmn.builder.AbstractBaseElementBuilder<B,UserTask>

io.camunda.zeebe.model.bpmn.builder.AbstractFlowElementBuilder<B,UserTask>

io.camunda.zeebe.model.bpmn.builder.AbstractFlowNodeBuilder<B,UserTask>

io.camunda.zeebe.model.bpmn.builder.AbstractActivityBuilder<B,UserTask>

io.camunda.zeebe.model.bpmn.builder.AbstractTaskBuilder<B,UserTask>

io.camunda.zeebe.model.bpmn.builder.AbstractUserTaskBuilder<B>

All Implemented Interfaces:

ZeebeUserTaskPropertiesBuilder<B>, ZeebeVariablesMappingBuilder<B>

Direct Known Subclasses:

UserTaskBuilder

public abstract class AbstractUserTaskBuilder<B extends AbstractUserTaskBuilder<B>>
extends AbstractTaskBuilder<B,UserTask>
implements ZeebeUserTaskPropertiesBuilder<B>

Author:

Sebastian Menski

Field Summary

Fields inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractFlowNodeBuilder

compensateBoundaryEvent, compensationStarted

Fields inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBaseElementBuilder

SPACE, ZEEBE_EXPRESSION_FORMAT

Fields inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBpmnModelElementBuilder

element, modelInstance, myself

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractUserTaskBuilder(BpmnModelInstance modelInstance, UserTask element, Class<?> selfType)

Method Summary

Modifier and Type	Method	Description
B	implementation(String implementation)	Sets the implementation of the build user task.
B	zeebeAssignee(String assignee)	Sets a static assignee for the user task
B	zeebeAssigneeExpression(String expression)	Sets a dynamic assignee for the user task that is retrieved from the given expression
B	zeebeCandidateGroups(String candidateGroups)	Sets a static candidateGroups for the user task
B	zeebeCandidateGroupsExpression(String expression)	Sets a dynamic candidateGroups for the user task that is retrieved from the given expression
B	zeebeCandidateUsers(String candidateUsers)	Sets a static candidateUsers for the user task
B	zeebeCandidateUsersExpression(String expression)	Sets a dynamic candidateUsers for the user task that is retrieved from the given expression
B	zeebeDueDate(String dueDate)	Sets a static dueDate for the user task
B	zeebeDueDateExpression(String expression)	Sets a dynamic dueDate for the user task that is retrieved from the given expression
B	zeebeExternalFormReference(String externalFormReference)	Sets a static external form reference for the user task.
B	zeebeExternalFormReferenceExpression(String expression)	Sets a dynamic external form reference for the user task that is retrieved from the given expression.
B	zeebeFollowUpDate(String followUpDate)	Sets a static followUpDate for the user task
B	zeebeFollowUpDateExpression(String expression)	Sets a dynamic followUpDate for the user task that is retrieved from the given expression
B	zeebeFormId(String formId)	Sets the form id of the build user task.
B	zeebeFormKey(String formKey)	Sets the form key of the build user task.
B	zeebeFormKey(String format, String location, String id)	Sets the form key with the format 'format:location:id' of the build user task.
B	zeebeTaskHeader(String key, String value)
B	zeebeUserTask()	Marks the user task as native Zeebe user task.
B	zeebeUserTaskForm(String userTaskForm)	Creates a new user task form with the given context, assuming it is of the format camunda-forms and embedded inside the diagram.
B	zeebeUserTaskForm(String id, String userTaskForm)	Creates a new user task form with the given context, assuming it is of the format camunda-forms and embedded inside the diagram.

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractActivityBuilder

boundaryEvent, boundaryEvent, boundaryEvent, calculateXCoordinate, multiInstance, multiInstance, setBoundaryEventCoordinates, zeebeInput, zeebeInputExpression, zeebeOutput, zeebeOutputExpression

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractFlowNodeBuilder

businessRuleTask, businessRuleTask, businessRuleTask, callActivity, callActivity, callActivity, compensationDone, compensationStart, condition, condition, conditionExpression, connectTarget, connectTargetWithAssociation, connectTargetWithSequenceFlow, connectTo, createTarget, createTargetBuilder, createTargetBuilder, endEvent, endEvent, endEvent, eventBasedGateway, eventBasedGateway, exclusiveGateway, exclusiveGateway, getCurrentSequenceFlowBuilder, inclusiveGateway, inclusiveGateway, intermediateCatchEvent, intermediateCatchEvent, intermediateCatchEvent, intermediateThrowEvent, intermediateThrowEvent, intermediateThrowEvent, isBoundaryEventWithStartedCompensation, isCompensationHandler, manualTask, manualTask, moveToActivity, moveToLastExclusiveGateway, moveToLastGateway, moveToLastInclusiveGateway, moveToNode, moveToProcess, parallelGateway, parallelGateway, receiveTask, receiveTask, receiveTask, scriptTask, scriptTask, scriptTask, sendTask, sendTask, sendTask, sequenceFlowId, serviceTask, serviceTask, serviceTask, subProcess, subProcess, subProcess, task, task, transaction, transaction, userTask, userTask, userTask

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractFlowElementBuilder

name

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBaseElementBuilder

addExtensionElement, addExtensionElement, asZeebeExpression, createBpmnShape, createChild, createChild, createChild, createChild, createCompensateEventDefinition, createEdge, createEmptyErrorEventDefinition, createEmptyEscalationEventDefinition, createEmptyMessageEventDefinition, createEmptySignalEventDefinition, createErrorEventDefinition, createEscalationEventDefinition, createInstance, createInstance, createMessage, createMessageEventDefinition, createSibling, createSibling, createSignal, createSignalEventDefinition, createZeebeUserTaskForm, findBpmnEdge, findBpmnPlane, findBpmnShape, findErrorDefinitionForCode, findErrorForNameAndCode, findEscalationForCode, findMessageForName, findProcess, findSignalForName, getCreateSingleChild, getCreateSingleChild, getCreateSingleExtensionElement, id, resizeBpmnShape, setCoordinates, setWaypoints, setWaypointsWithSourceAndTarget

Methods inherited from class io.camunda.zeebe.model.bpmn.builder.AbstractBpmnModelElementBuilder

documentation, done, getElement, subProcessDone, throwEventDefinitionDone, transactionDone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractUserTaskBuilder

protected AbstractUserTaskBuilder(BpmnModelInstance modelInstance,
 UserTask element,
 Class<?> selfType)

Method Details

implementation

public B implementation(String implementation)

Sets the implementation of the build user task.

Parameters:

implementation - the implementation to set

Returns:

the builder object

zeebeFormKey

public B zeebeFormKey(String format,
 String location,
 String id)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets the form key with the format 'format:location:id' of the build user task.

Specified by:

zeebeFormKey in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

format - the format of the reference form

location - the location where the form is available

id - the id of the form

Returns:

the builder object

zeebeFormKey

public B zeebeFormKey(String formKey)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets the form key of the build user task.

Specified by:

zeebeFormKey in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

formKey - the form key to set

Returns:

the builder object

zeebeUserTaskForm

public B zeebeUserTaskForm(String userTaskForm)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Creates a new user task form with the given context, assuming it is of the format camunda-forms and embedded inside the diagram.

Specified by:

zeebeUserTaskForm in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

userTaskForm - the XML encoded user task form json in the camunda-forms format

Returns:

the builder object

zeebeUserTaskForm

public B zeebeUserTaskForm(String id,
 String userTaskForm)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Creates a new user task form with the given context, assuming it is of the format camunda-forms and embedded inside the diagram.

Specified by:

zeebeUserTaskForm in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

id - the unique identifier of the user task form element

userTaskForm - the XML encoded user task form json in the camunda-forms format

Returns:

the builder object

zeebeAssignee

public B zeebeAssignee(String assignee)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a static assignee for the user task

Specified by:

zeebeAssignee in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

assignee - the assignee of the user task

Returns:

the builder object

zeebeAssigneeExpression

public B zeebeAssigneeExpression(String expression)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a dynamic assignee for the user task that is retrieved from the given expression

Specified by:

zeebeAssigneeExpression in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

expression - the expression for the assignee of the user task

Returns:

the builder object

zeebeCandidateGroups

public B zeebeCandidateGroups(String candidateGroups)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a static candidateGroups for the user task

Specified by:

zeebeCandidateGroups in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

candidateGroups - the candidateGroups of the user task

Returns:

the builder object

zeebeCandidateGroupsExpression

public B zeebeCandidateGroupsExpression(String expression)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a dynamic candidateGroups for the user task that is retrieved from the given expression

Specified by:

zeebeCandidateGroupsExpression in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

expression - the expression for the candidateGroups of the user task

Returns:

the builder object

zeebeCandidateUsers

public B zeebeCandidateUsers(String candidateUsers)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a static candidateUsers for the user task

Specified by:

zeebeCandidateUsers in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

candidateUsers - the candidateUsers of the user task

Returns:

the builder object

zeebeCandidateUsersExpression

public B zeebeCandidateUsersExpression(String expression)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a dynamic candidateUsers for the user task that is retrieved from the given expression

Specified by:

zeebeCandidateUsersExpression in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

expression - the expression for the candidateUsers of the user task

Returns:

the builder object

zeebeDueDate

public B zeebeDueDate(String dueDate)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a static dueDate for the user task

Specified by:

zeebeDueDate in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

dueDate - the dueDate of the user task

Returns:

the builder object

zeebeDueDateExpression

public B zeebeDueDateExpression(String expression)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a dynamic dueDate for the user task that is retrieved from the given expression

Specified by:

zeebeDueDateExpression in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

expression - the expression for the dueDate of the user task

Returns:

the builder object

zeebeFollowUpDate

public B zeebeFollowUpDate(String followUpDate)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a static followUpDate for the user task

Specified by:

zeebeFollowUpDate in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

followUpDate - the followUpDate of the user task

Returns:

the builder object

zeebeFollowUpDateExpression

public B zeebeFollowUpDateExpression(String expression)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a dynamic followUpDate for the user task that is retrieved from the given expression

Specified by:

zeebeFollowUpDateExpression in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

expression - the expression for the followUpDate of the user task

Returns:

the builder object

zeebeFormId

public B zeebeFormId(String formId)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets the form id of the build user task.

Specified by:

zeebeFormId in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

formId - the form id to set

Returns:

the builder object

zeebeUserTask

public B zeebeUserTask()

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Marks the user task as native Zeebe user task.

Specified by:

zeebeUserTask in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Returns:

the builder object

zeebeExternalFormReference

public B zeebeExternalFormReference(String externalFormReference)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a static external form reference for the user task.

Specified by:

zeebeExternalFormReference in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

externalFormReference - the external form reference of the user task

Returns:

the builder object

zeebeExternalFormReferenceExpression

public B zeebeExternalFormReferenceExpression(String expression)

Description copied from interface: ZeebeUserTaskPropertiesBuilder

Sets a dynamic external form reference for the user task that is retrieved from the given expression.

Specified by:

zeebeExternalFormReferenceExpression in interface ZeebeUserTaskPropertiesBuilder<B extends AbstractUserTaskBuilder<B>>

Parameters:

expression - the expression for the external form reference of the user task

Returns:

the builder object

zeebeTaskHeader

public B zeebeTaskHeader(String key,
 String value)