Package io.camunda.client.impl.command

Class CompleteUserTaskJobResultImpl

java.lang.Object

io.camunda.client.impl.command.CompleteUserTaskJobResultImpl

All Implemented Interfaces:

CompleteJobResult, CompleteUserTaskJobResultStep1

public class CompleteUserTaskJobResultImpl
extends Object
implements CompleteUserTaskJobResultStep1

Constructor Summary

Constructors

Constructor	Description
CompleteUserTaskJobResultImpl()

Method Summary

Modifier and Type	Method	Description
CompleteUserTaskJobResultImpl	correct(JobResultCorrections corrections)	Applies corrections to the user task attributes.
CompleteUserTaskJobResultImpl	correct(UnaryOperator<JobResultCorrections> corrections)	Dynamically applies corrections to the user task attributes using a lambda expression.
CompleteUserTaskJobResultImpl	correctAssignee(String assignee)	Correct the assignee of the task.
CompleteUserTaskJobResultImpl	correctCandidateGroups(List<String> candidateGroups)	Correct the candidate groups of the task.
CompleteUserTaskJobResultImpl	correctCandidateUsers(List<String> candidateUsers)	Correct the candidate users of the task.
CompleteUserTaskJobResultImpl	correctDueDate(String dueDate)	Correct the due date of the task.
CompleteUserTaskJobResultImpl	correctFollowUpDate(String followUpDate)	Correct the follow up date of the task.
CompleteUserTaskJobResultImpl	correctPriority(Integer priority)	Correct the priority of the task.
CompleteUserTaskJobResultImpl	deniedReason(String deniedReason)	Indicates the reason why the worker denied the job.
CompleteUserTaskJobResultImpl	deny(boolean isDenied)	Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
CompleteUserTaskJobResultImpl	deny(boolean isDenied, String deniedReason)	Indicates whether the worker denies the work, i.e. explicitly doesn't approve it.
JobResultCorrections	getCorrections()
String	getDeniedReason()
JobResultType	getType()	Get the type of the job result.
boolean	isDenied()

Methods inherited from class java.lang.Object

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

Constructor Details

CompleteUserTaskJobResultImpl

public CompleteUserTaskJobResultImpl()

Method Details

deny

public CompleteUserTaskJobResultImpl deny(boolean isDenied)

Description copied from interface: CompleteUserTaskJobResultStep1

Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a user task listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false.

Specified by:

deny in interface CompleteUserTaskJobResultStep1

Parameters:

isDenied - indicates if the worker has denied the reason for the job

Returns:

this job result

deny

public CompleteUserTaskJobResultImpl deny(boolean isDenied,
 String deniedReason)

Description copied from interface: CompleteUserTaskJobResultStep1

Indicates whether the worker denies the work, i.e. explicitly doesn't approve it. For example, a user task listener can deny the completion of a task by setting this flag to true. In this example, the completion of a task is represented by a job that the worker can complete as denied. As a result, the completion request is rejected and the task remains active. Defaults to false. This method also allows setting the reason for denying the job. Default to an empty string.

Specified by:

deny in interface CompleteUserTaskJobResultStep1

Parameters:

isDenied - indicates if the worker has denied the reason for the job

deniedReason - indicates the reason why the worker denied the job

Returns:

this job result

deniedReason

public CompleteUserTaskJobResultImpl deniedReason(String deniedReason)

Description copied from interface: CompleteUserTaskJobResultStep1

Indicates the reason why the worker denied the job. For example, a user task listener can deny the completion of a task by setting the deny flag to true and specifying the reason to deny. Defaults to an empty string.

Specified by:

deniedReason in interface CompleteUserTaskJobResultStep1

Parameters:

deniedReason - indicates the reason why the worker denied the job

Returns:

this job result

correct

public CompleteUserTaskJobResultImpl correct(JobResultCorrections corrections)

Description copied from interface: CompleteUserTaskJobResultStep1

Applies corrections to the user task attributes.

This method allows the worker to modify key attributes of the user task (such as assignee, candidateGroups, and so on).

Specified by:

correct in interface CompleteUserTaskJobResultStep1

Parameters:

corrections - the corrections to apply to the user task.

Returns:

this job result

correct

public CompleteUserTaskJobResultImpl correct(UnaryOperator<JobResultCorrections> corrections)

Description copied from interface: CompleteUserTaskJobResultStep1

Dynamically applies corrections to the user task attributes using a lambda expression.

This method is a functional alternative to CompleteUserTaskJobResultStep1.correct(JobResultCorrections). It allows the worker to modify key user task attributes (such as assignee, dueDate, priority, and so on) directly via a lambda expression. The lambda receives the current JobResultCorrections instance, which can be updated as needed. If no corrections have been set yet, a default JobResultCorrections instance is provided.

Specified by:

correct in interface CompleteUserTaskJobResultStep1

Parameters:

corrections - a lambda expression to modify the JobResultCorrections.

Returns:

this job result

correctAssignee

public CompleteUserTaskJobResultImpl correctAssignee(String assignee)

Description copied from interface: CompleteUserTaskJobResultStep1

Correct the assignee of the task.

Specified by:

correctAssignee in interface CompleteUserTaskJobResultStep1

Parameters:

assignee - assignee of the task

Returns:

this job result

correctDueDate

public CompleteUserTaskJobResultImpl correctDueDate(String dueDate)

Description copied from interface: CompleteUserTaskJobResultStep1

Correct the due date of the task.

Specified by:

correctDueDate in interface CompleteUserTaskJobResultStep1

Parameters:

dueDate - due date of the task

Returns:

this job result

correctFollowUpDate

public CompleteUserTaskJobResultImpl correctFollowUpDate(String followUpDate)

Description copied from interface: CompleteUserTaskJobResultStep1

Correct the follow up date of the task.

Specified by:

correctFollowUpDate in interface CompleteUserTaskJobResultStep1

Parameters:

followUpDate - follow up date of the task

Returns:

this job result

correctCandidateGroups

public CompleteUserTaskJobResultImpl correctCandidateGroups(List<String> candidateGroups)

Description copied from interface: CompleteUserTaskJobResultStep1

Correct the candidate groups of the task.

Specified by:

correctCandidateGroups in interface CompleteUserTaskJobResultStep1

Parameters:

candidateGroups - candidate groups of the task

Returns:

this job result

correctCandidateUsers

public CompleteUserTaskJobResultImpl correctCandidateUsers(List<String> candidateUsers)

Description copied from interface: CompleteUserTaskJobResultStep1

Correct the candidate users of the task.

Specified by:

correctCandidateUsers in interface CompleteUserTaskJobResultStep1

Parameters:

candidateUsers - candidate users of the task

Returns:

this job result

correctPriority

public CompleteUserTaskJobResultImpl correctPriority(Integer priority)

Description copied from interface: CompleteUserTaskJobResultStep1

Correct the priority of the task.

Specified by:

correctPriority in interface CompleteUserTaskJobResultStep1

Parameters:

priority - priority of the task

Returns:

this job result

isDenied

public boolean isDenied()

getDeniedReason

public String getDeniedReason()

getCorrections

public JobResultCorrections getCorrections()

getType

public JobResultType getType()

Description copied from interface: CompleteJobResult

Get the type of the job result. Depending on the type, different fields will be set on the request. These fields are used to perform follow-up actions on the job upon completion. Eg: changing the assignee of a user task, or activating certain elements of an ad-hoc sub process.

Specified by:

getType in interface CompleteJobResult

Returns:

the type of the job result