Package org.activiti.api.task.runtime

Interface TaskAdminRuntime

public interface TaskAdminRuntime
All the methods require an authenticated Admin user

  • Method Details

    • delete

      Task delete(DeleteTaskPayload deleteTaskPayload)
      Deletes a task - no matter the assignee or if the admin user can see the task

    • task

      Task task(String taskId)
      Get Task By Id

    • tasks

      Page<Task> tasks(Pageable pageable)
      Get all tasks

    • tasks

      Page<Task> tasks(Pageable pageable, GetTasksPayload getTasksPayload)
      Get all tasks with payload filters

    • claim

      Task claim(ClaimTaskPayload claimTaskPayload)
      Claim a task with the currently authenticated user - If there is no authenticated user throw an IllegalStateException - If the currently authenticated user is not a candidate throw an IllegalStateException - The current approach doesn't support impersonation, it will always take the currently authenticated user - after the claim the task should be in assigned status

    • release

      Task release(ReleaseTaskPayload releaseTaskPayload)
      Release a previously claimed task - The authenticated user needs to be the assignee in order to release it

    • complete

      Task complete(CompleteTaskPayload completeTaskPayload)
      Completes the selected task with the variables set in the payload - This method checks that the task is visible by the authenticated user - This method also check that the task is assigned to the currently authenticated user before complete - This method return a shallow Task object with the basic information needed to validate that the task was completed

    • update

      Task update(UpdateTaskPayload updateTaskPayload)
      Updates details of a task

    • createVariable

      void createVariable(CreateTaskVariablePayload createTaskVariablePayload)

    • updateVariable

      void updateVariable(UpdateTaskVariablePayload updateTaskVariablePayload)

    • variables

      List<VariableInstance> variables(GetTaskVariablesPayload getTaskVariablesPayload)

    • assign

      Task assign(AssignTaskPayload assignTaskPayload)
      Assign a task with a new user - If there is a user assigned, reassign it to the new user - after the assign the task should be in assigned status

    • assignMultiple

      Page<Task> assignMultiple(AssignTasksPayload assignTasksPayload)

    • addCandidateUsers

      void addCandidateUsers(CandidateUsersPayload candidateUsersPayload)

    • deleteCandidateUsers

      void deleteCandidateUsers(CandidateUsersPayload candidateUsersPayload)

    • addCandidateGroups

      void addCandidateGroups(CandidateGroupsPayload candidateGroupsPayload)

    • deleteCandidateGroups

      void deleteCandidateGroups(CandidateGroupsPayload candidateGroupsPayload)

    • userCandidates

      List<String> userCandidates(String taskId)

    • groupCandidates

      List<String> groupCandidates(String taskId)