Package io.camunda.client.api.command

Interface CompleteUserTaskJobResultStep1

All Superinterfaces:
CompleteJobResult
All Known Implementing Classes:
CompleteUserTaskJobResultImpl
public interface CompleteUserTaskJobResultStep1 extends CompleteJobResult

  • Method Details

    • deny

      CompleteUserTaskJobResultStep1 deny(boolean isDenied)
      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.
      Parameters:
      isDenied - indicates if the worker has denied the reason for the job
      Returns:
      this job result

    • deny

      CompleteUserTaskJobResultStep1 deny(boolean isDenied, String deniedReason)
      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.
      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

      CompleteUserTaskJobResultStep1 deniedReason(String deniedReason)
      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.
      Parameters:
      deniedReason - indicates the reason why the worker denied the job
      Returns:
      this job result

    • correct

      CompleteUserTaskJobResultStep1 correct(JobResultCorrections corrections)
      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).

      Parameters:
      corrections - the corrections to apply to the user task.
      Returns:
      this job result

    • correct

      CompleteUserTaskJobResultStep1 correct(UnaryOperator<JobResultCorrections> corrections)
      Dynamically applies corrections to the user task attributes using a lambda expression.

      This method is a functional alternative to 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.

      Parameters:
      corrections - a lambda expression to modify the JobResultCorrections.
      Returns:
      this job result

    • correctAssignee

      CompleteUserTaskJobResultStep1 correctAssignee(String assignee)
      Correct the assignee of the task.
      Parameters:
      assignee - assignee of the task
      Returns:
      this job result

    • correctDueDate

      CompleteUserTaskJobResultStep1 correctDueDate(String dueDate)
      Correct the due date of the task.
      Parameters:
      dueDate - due date of the task
      Returns:
      this job result

    • correctFollowUpDate

      CompleteUserTaskJobResultStep1 correctFollowUpDate(String followUpDate)
      Correct the follow up date of the task.
      Parameters:
      followUpDate - follow up date of the task
      Returns:
      this job result

    • correctCandidateGroups

      CompleteUserTaskJobResultStep1 correctCandidateGroups(List<String> candidateGroups)
      Correct the candidate groups of the task.
      Parameters:
      candidateGroups - candidate groups of the task
      Returns:
      this job result

    • correctCandidateUsers

      CompleteUserTaskJobResultStep1 correctCandidateUsers(List<String> candidateUsers)
      Correct the candidate users of the task.
      Parameters:
      candidateUsers - candidate users of the task
      Returns:
      this job result

    • correctPriority

      CompleteUserTaskJobResultStep1 correctPriority(Integer priority)
      Correct the priority of the task.
      Parameters:
      priority - priority of the task
      Returns:
      this job result