Package org.activiti.api.task.runtime

Interface TaskAdminRuntime

  • public interface TaskAdminRuntime
    All the methods require an authenticated Admin user

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addCandidateGroups​(org.activiti.api.task.model.payloads.CandidateGroupsPayload candidateGroupsPayload)  
      void addCandidateUsers​(org.activiti.api.task.model.payloads.CandidateUsersPayload candidateUsersPayload)  
      org.activiti.api.task.model.Task assign​(org.activiti.api.task.model.payloads.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
      org.activiti.api.task.model.Task claim​(org.activiti.api.task.model.payloads.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
      org.activiti.api.task.model.Task complete​(org.activiti.api.task.model.payloads.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
      void createVariable​(org.activiti.api.task.model.payloads.CreateTaskVariablePayload createTaskVariablePayload)  
      org.activiti.api.task.model.Task delete​(org.activiti.api.task.model.payloads.DeleteTaskPayload deleteTaskPayload)
      Deletes a task - no matter the assignee or if the admin user can see the task
      void deleteCandidateGroups​(org.activiti.api.task.model.payloads.CandidateGroupsPayload candidateGroupsPayload)  
      void deleteCandidateUsers​(org.activiti.api.task.model.payloads.CandidateUsersPayload candidateUsersPayload)  
      java.util.List<java.lang.String> groupCandidates​(java.lang.String taskId)  
      org.activiti.api.task.model.Task release​(org.activiti.api.task.model.payloads.ReleaseTaskPayload releaseTaskPayload)
      Release a previously claimed task - The authenticated user needs to be the assignee in order to release it
      org.activiti.api.task.model.Task task​(java.lang.String taskId)
      Get Task By Id
      org.activiti.api.runtime.shared.query.Page<org.activiti.api.task.model.Task> tasks​(org.activiti.api.runtime.shared.query.Pageable pageable)
      Get all tasks
      org.activiti.api.runtime.shared.query.Page<org.activiti.api.task.model.Task> tasks​(org.activiti.api.runtime.shared.query.Pageable pageable, org.activiti.api.task.model.payloads.GetTasksPayload getTasksPayload)
      Get all tasks with payload filters
      org.activiti.api.task.model.Task update​(org.activiti.api.task.model.payloads.UpdateTaskPayload updateTaskPayload)
      Updates details of a task
      void updateVariable​(org.activiti.api.task.model.payloads.UpdateTaskVariablePayload updateTaskVariablePayload)  
      java.util.List<java.lang.String> userCandidates​(java.lang.String taskId)  
      java.util.List<org.activiti.api.model.shared.model.VariableInstance> variables​(org.activiti.api.task.model.payloads.GetTaskVariablesPayload getTaskVariablesPayload)  

    • Method Detail

      • delete

        org.activiti.api.task.model.Task delete​(org.activiti.api.task.model.payloads.DeleteTaskPayload deleteTaskPayload)
        Deletes a task - no matter the assignee or if the admin user can see the task

      • task

        org.activiti.api.task.model.Task task​(java.lang.String taskId)
        Get Task By Id

      • tasks

        org.activiti.api.runtime.shared.query.Page<org.activiti.api.task.model.Task> tasks​(org.activiti.api.runtime.shared.query.Pageable pageable)
        Get all tasks

      • tasks

        org.activiti.api.runtime.shared.query.Page<org.activiti.api.task.model.Task> tasks​(org.activiti.api.runtime.shared.query.Pageable pageable,
                                                                                   org.activiti.api.task.model.payloads.GetTasksPayload getTasksPayload)
        Get all tasks with payload filters

      • claim

        org.activiti.api.task.model.Task claim​(org.activiti.api.task.model.payloads.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

        org.activiti.api.task.model.Task release​(org.activiti.api.task.model.payloads.ReleaseTaskPayload releaseTaskPayload)
        Release a previously claimed task - The authenticated user needs to be the assignee in order to release it

      • complete

        org.activiti.api.task.model.Task complete​(org.activiti.api.task.model.payloads.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

        org.activiti.api.task.model.Task update​(org.activiti.api.task.model.payloads.UpdateTaskPayload updateTaskPayload)
        Updates details of a task

      • createVariable

        void createVariable​(org.activiti.api.task.model.payloads.CreateTaskVariablePayload createTaskVariablePayload)

      • updateVariable

        void updateVariable​(org.activiti.api.task.model.payloads.UpdateTaskVariablePayload updateTaskVariablePayload)

      • variables

        java.util.List<org.activiti.api.model.shared.model.VariableInstance> variables​(org.activiti.api.task.model.payloads.GetTaskVariablesPayload getTaskVariablesPayload)

      • assign

        org.activiti.api.task.model.Task assign​(org.activiti.api.task.model.payloads.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

      • addCandidateUsers

        void addCandidateUsers​(org.activiti.api.task.model.payloads.CandidateUsersPayload candidateUsersPayload)

      • deleteCandidateUsers

        void deleteCandidateUsers​(org.activiti.api.task.model.payloads.CandidateUsersPayload candidateUsersPayload)

      • addCandidateGroups

        void addCandidateGroups​(org.activiti.api.task.model.payloads.CandidateGroupsPayload candidateGroupsPayload)

      • deleteCandidateGroups

        void deleteCandidateGroups​(org.activiti.api.task.model.payloads.CandidateGroupsPayload candidateGroupsPayload)

      • userCandidates

        java.util.List<java.lang.String> userCandidates​(java.lang.String taskId)

      • groupCandidates

        java.util.List<java.lang.String> groupCandidates​(java.lang.String taskId)