Package cronapi.workflow

Class WorkflowTaskOperations

  • public class WorkflowTaskOperations
extends Object
    Serviço para operações dos Human Tasks do Bpmn ...
    Since:
    2019-06-26
    Version:
    1.0
    Author:
    Ricardo Caldas

    • Constructor Detail

      • WorkflowTaskOperations

        public WorkflowTaskOperations()

    • Method Detail

      • newTask

        public static org.camunda.bpm.engine.task.Task newTask​(String taskId)
        create a new task with a user defined task id
        Parameters:
        taskId - String
        Returns:
        Task

      • saveTask

        public static void saveTask​(org.camunda.bpm.engine.task.Task task)
        Saves the given task to the persistent data store. If the task is already present in the persistent store, it is updated. After a new task has been saved, the task instance passed into this method is updated with the id of the newly created task.
        Parameters:
        task - the task, cannot be null.
        Throws:
        org.camunda.bpm.engine.AuthorizationException - If the task is already present and the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION. Or if the task is not present and the user has no Permissions.CREATE permission on Resources.TASK.

      • deleteTask

        public static void deleteTask​(String taskId,
                              boolean cascade)
        Deletes the given task.
        Parameters:
        taskId - The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.
        cascade - If cascade is true, also the historic information related to this task is deleted.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when an error occurs while deleting the task or in case the task is part of a running process or case instance.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.DELETE permission on Resources.TASK.

      • deleteTasks

        public static void deleteTasks​(Collection<String> taskIds,
                               boolean cascade)
        Deletes all tasks of the given collection.
        Parameters:
        taskIds - The id's of the tasks that will be deleted, cannot be null. All id's in the list that don't have an existing task will be ignored.
        cascade - If cascade is true, also the historic information related to this task is deleted.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when an error occurs while deleting the tasks or in case one of the tasks is part of a running process or case instance.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.DELETE permission on Resources.TASK.

      • claim

        public static void claim​(String taskId,
                         String userId)
        Claim responsibility for a task: the given user is made assignee for the task. The difference with setAssignee(String, String) is that here a check is done if the task already has a user assigned to it. No check is done whether the user is known by the identity component.
        Parameters:
        taskId - task to claim, cannot be null.
        userId - user that claims the task. When userId is null the task is unclaimed, assigned to no one.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist or when the task is already claimed by another user.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • complete

        public static void complete​(String taskId)
        Marks a task as done and continues process execution.

        This method is typically called by a task list user interface after a task form has been submitted by the assignee.

        Parameters:
        taskId - the id of the task to complete, cannot be null.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when no task exists with the given id or when this task is DelegationState.PENDING delegation.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • delegateTask

        public static void delegateTask​(String taskId,
                                String userId)
        Delegates the task to another user.

        This means that the assignee is set and the delegation state is set to DelegationState.PENDING. If no owner is set on the task, the owner is set to the current assignee of the task. The new assignee must use TaskService.resolveTask(String) to report back to the owner. Only the owner can complete the task.

        Parameters:
        taskId - The id of the task that will be delegated.
        userId - The id of the user that will be set as assignee.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when no task exists with the given id.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • resolveTask

        public static void resolveTask​(String taskId,
                               Map<String,​Object> variables)
        Marks that the assignee is done with the task delegated to her and that it can be sent back to the owner with the provided variables. Can only be called when this task is DelegationState.PENDING delegation. After this method returns, the delegation state is set to DelegationState.RESOLVED and the task can be completed.
        Parameters:
        taskId - String
        variables - Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when no task exists with the given id.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • complete

        public static void complete​(String taskId,
                            Map<String,​Object> variables)
        Marks a task as done and continues process execution.

        This method is typically called by a task list user interface after a task form has been submitted by the assignee and the required task parameters have been provided.

        Parameters:
        taskId - the id of the task to complete, cannot be null.
        variables - task parameters. May be null or empty.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when no task exists with the given id.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • setAssignee

        public static void setAssignee​(String taskId,
                               String userId)
        Changes the assignee of the given task to the given userId. No check is done whether the user is known by the identity component.
        Parameters:
        taskId - id of the task, cannot be null.
        userId - id of the user to use as assignee.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or user doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • setOwner

        public static void setOwner​(String taskId,
                            String userId)
        Transfers ownership of this task to another user. No check is done whether the user is known by the identity component.
        Parameters:
        taskId - id of the task, cannot be null.
        userId - of the person that is receiving ownership.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or user doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getIdentityLinksForTask

        public static List<org.camunda.bpm.engine.task.IdentityLink> getIdentityLinksForTask​(String taskId)
        Retrieves the IdentityLinks associated with the given task. Such an IdentityLink informs how a certain identity (eg. group or user) is associated with a certain task (eg. as candidate, assignee, etc.)
        Parameters:
        taskId - String
        Returns:
        Lista
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • addCandidateUser

        public static void addCandidateUser​(String taskId,
                                    String userId)
        Convenience shorthand for addUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
        Parameters:
        taskId - id of the task, cannot be null.
        userId - id of the user to use as candidate, cannot be null.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or user doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • addCandidateGroup

        public static void addCandidateGroup​(String taskId,
                                     String groupId)
        Convenience shorthand for addGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
        Parameters:
        taskId - id of the task, cannot be null.
        groupId - id of the group to use as candidate, cannot be null.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or group doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • addUserIdentityLink

        public static void addUserIdentityLink​(String taskId,
                                       String userId,
                                       String identityLinkType)
        Involves a user with a task. The type of identity link is defined by the given identityLinkType.
        Parameters:
        taskId - id of the task, cannot be null.
        userId - id of the user involve, cannot be null.
        identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or user doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • addGroupIdentityLink

        public static void addGroupIdentityLink​(String taskId,
                                        String groupId,
                                        String identityLinkType)
        Involves a group with a task. The type of identityLink is defined by the given identityLink.
        Parameters:
        taskId - id of the task, cannot be null.
        groupId - id of the group to involve, cannot be null.
        identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or group doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • deleteCandidateUser

        public static void deleteCandidateUser​(String taskId,
                                       String userId)
        Convenience shorthand for deleteUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
        Parameters:
        taskId - id of the task, cannot be null.
        userId - id of the user to use as candidate, cannot be null.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or user doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • deleteCandidateGroup

        public static void deleteCandidateGroup​(String taskId,
                                        String groupId)
        Convenience shorthand for deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
        Parameters:
        taskId - id of the task, cannot be null.
        groupId - id of the group to use as candidate, cannot be null.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or group doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • deleteUserIdentityLink

        public static void deleteUserIdentityLink​(String taskId,
                                          String userId,
                                          String identityLinkType)
        Removes the association between a user and a task for the given identityLinkType.
        Parameters:
        taskId - id of the task, cannot be null.
        userId - id of the user involve, cannot be null.
        identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or user doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • deleteGroupIdentityLink

        public static void deleteGroupIdentityLink​(String taskId,
                                           String groupId,
                                           String identityLinkType)
        Removes the association between a group and a task for the given identityLinkType.
        Parameters:
        taskId - id of the task, cannot be null.
        groupId - id of the group to involve, cannot be null.
        identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task or group doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • setPriority

        public static void setPriority​(String taskId,
                               int priority)
        Changes the priority of the task.

        Authorization: actual owner / business admin

        Parameters:
        taskId - id of the task, cannot be null.
        priority - the new priority for the task.
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • createTaskQuery

        public static org.camunda.bpm.engine.task.TaskQuery createTaskQuery​(String taskID)
        Returns a new TaskQuery that can be used to dynamically query tasks.
        Parameters:
        taskID - String
        Returns:
        TaskQuery

      • createNativeTaskQuery

        public static org.camunda.bpm.engine.task.NativeTaskQuery createNativeTaskQuery()
        Returns a new
        Returns:
        NativeTaskQuery

      • setVariable

        public static void setVariable​(String taskId,
                               String variableName,
                               Object value)
        Set variable on a task. If the variable is not already existing, it will be created in the most outer scope. This means the process instance in case this task is related to an execution.
        Parameters:
        taskId - String
        variableName - String
        value - Object
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • setVariables

        public static void setVariables​(String taskId,
                                Map<String,​?> variables)
        Set variables on a task. If the variable is not already existing, it will be created in the most outer scope. This means the process instance in case this task is related to an execution.
        Parameters:
        taskId - String
        variables - Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • setVariableLocal

        public static void setVariableLocal​(String taskId,
                                    String variableName,
                                    Object value)
        Set variable on a task. If the variable is not already existing, it will be created in the task.
        Parameters:
        taskId - String
        variableName - String
        value - Object
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • setVariablesLocal

        public static void setVariablesLocal​(String taskId,
                                     Map<String,​?> variables)
        Set variables on a task. If the variable is not already existing, it will be created in the task.
        Parameters:
        taskId - String
        variables - Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariable

        public static Object getVariable​(String taskId,
                                 String variableName)
        Get a variables and search in the task scope and if available also the execution scopes.
        Parameters:
        taskId - String
        variableName - String
        Returns:
        Object
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariableTyped

        public static <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped​(String taskId,
                                                                                              String variableName)
        Get a variables and search in the task scope and if available also the execution scopes.
        Type Parameters:
        T - TypedValue
        Parameters:
        taskId - the id of the task
        variableName - the name of the variable to fetch
        Returns:
        the TypedValue for the variable or 'null' in case no such variable exists.
        Throws:
        ClassCastException - in case the value is not of the requested type
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • getVariableTyped

        public static <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableTyped​(String taskId,
                                                                                              String variableName,
                                                                                              boolean deserializeValue)
        Get a variables and search in the task scope and if available also the execution scopes.
        Type Parameters:
        T - TypedValue
        Parameters:
        taskId - the id of the task
        variableName - the name of the variable to fetch
        deserializeValue - if false a, SerializableValue will not be deserialized.
        Returns:
        the TypedValue for the variable or 'null' in case no such variable exists.
        Throws:
        ClassCastException - in case the value is not of the requested type
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • getVariableLocal

        public static Object getVariableLocal​(String taskId,
                                      String variableName)
        Get a variables and only search in the task scope.
        Parameters:
        taskId - String
        variableName - String
        Returns:
        Object
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariableLocalTyped

        public static <T extends org.camunda.bpm.engine.variable.value.TypedValue> T getVariableLocalTyped​(String taskId,
                                                                                                   String variableName,
                                                                                                   boolean deserializeValue)
        Get a variables and only search in the task scope.
        Type Parameters:
        T - TypedValue
        Parameters:
        taskId - the id of the task
        variableName - the name of the variable to fetch
        deserializeValue - if false a, SerializableValue will not be deserialized.
        Returns:
        the TypedValue for the variable or 'null' in case no such variable exists.
        Throws:
        ClassCastException - in case the value is not of the requested type
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • getVariables

        public static Map<String,​Object> getVariables​(String taskId)
        Get all variables and search in the task scope and if available also the execution scopes. If you have many variables and you only need a few, consider using getVariables(String, Collection) for better performance.
        Parameters:
        taskId - String
        Returns:
        Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariablesTyped

        public static org.camunda.bpm.engine.variable.VariableMap getVariablesTyped​(String taskId,
                                                                            boolean deserializeValues)
        Get all variables and search in the task scope and if available also the execution scopes. If you have many variables and you only need a few, consider using getVariables(String, Collection) for better performance.
        Parameters:
        taskId - the id of the task
        deserializeValues - if false, SerializableValues will not be deserialized.
        Returns:
        VariableMap
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • getVariablesLocal

        public static Map<String,​Object> getVariablesLocal​(String taskId)
        Get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider using getVariablesLocal(String, Collection) for better performance.
        Parameters:
        taskId - String
        Returns:
        Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariablesLocalTyped

        public static org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped​(String taskId,
                                                                                 boolean deserializeValues)
        Get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider using getVariablesLocal(String, Collection) for better performance.
        Parameters:
        taskId - the id of the task
        deserializeValues - if false, SerializableValues will not be deserialized.
        Returns:
        VariableMap
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • getVariables

        public static Map<String,​Object> getVariables​(String taskId,
                                                    Collection<String> variableNames)
        Get values for all given variableNames
        Parameters:
        taskId - String
        variableNames - Lista
        Returns:
        Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariablesTyped

        public static org.camunda.bpm.engine.variable.VariableMap getVariablesTyped​(String taskId,
                                                                            Collection<String> variableNames,
                                                                            boolean deserializeValues)
        Get values for all given variableName
        Parameters:
        taskId - the id of the task
        variableNames - only fetch variables whose names are in the collection.
        deserializeValues - if false, SerializableValues will not be deserialized.
        Returns:
        VariableMap
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • getVariablesLocal

        public static Map<String,​Object> getVariablesLocal​(String taskId,
                                                         Collection<String> variableNames)
        Get a variable on a task
        Parameters:
        taskId - String
        variableNames - Lista
        Returns:
        Mapa
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • getVariablesLocalTyped

        public static org.camunda.bpm.engine.variable.VariableMap getVariablesLocalTyped​(String taskId,
                                                                                 Collection<String> variableNames,
                                                                                 boolean deserializeValues)
        Get values for all given variableName. Only search in the local task scope.
        Parameters:
        taskId - the id of the task
        variableNames - only fetch variables whose names are in the collection.
        deserializeValues - if false, SerializableValues will not be deserialized.
        Returns:
        VariableMap
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.READ permission on Resources.TASK or no Permissions.READ_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).
        Since:
        7.2

      • removeVariable

        public static void removeVariable​(String taskId,
                                  String variableName)
        Removes the variable from the task. When the variable does not exist, nothing happens.
        Parameters:
        taskId - String
        variableName - String
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • removeVariableLocal

        public static void removeVariableLocal​(String taskId,
                                       String variableName)
        Removes the variable from the task (not considering parent scopes). When the variable does not exist, nothing happens.
        Parameters:
        taskId - String
        variableName - String
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • removeVariables

        public static void removeVariables​(String taskId,
                                   Collection<String> variableNames)
        Removes all variables in the given collection from the task. Non existing variable names are simply ignored.
        Parameters:
        taskId - String
        variableNames - Lista
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • removeVariablesLocal

        public static void removeVariablesLocal​(String taskId,
                                        Collection<String> variableNames)
        Removes all variables in the given collection from the task (not considering parent scopes). Non existing variable names are simply ignored.
        Parameters:
        taskId - String
        variableNames - Lista
        Throws:
        org.camunda.bpm.engine.ProcessEngineException - when the task doesn't exist.
        org.camunda.bpm.engine.AuthorizationException - If the user has no Permissions.UPDATE permission on Resources.TASK or no Permissions.UPDATE_TASK permission on Resources.PROCESS_DEFINITION (if the task is part of a running process instance).

      • createComment

        public static org.camunda.bpm.engine.task.Comment createComment​(String taskId,
                                                                String processInstanceId,
                                                                String message)
        Creates a comment to a task and/or process instance and returns the comment.
        Parameters:
        taskId - String
        processInstanceId - String
        message - String
        Returns:
        Comment

      • getTaskComments

        public static List<org.camunda.bpm.engine.task.Comment> getTaskComments​(String taskId)
        The comments related to the given task.
        Parameters:
        taskId - String
        Returns:
        Lista

      • getTaskComment

        public static org.camunda.bpm.engine.task.Comment getTaskComment​(String taskId,
                                                                 String commentId)
        Retrieve a particular task comment
        Parameters:
        taskId - String
        commentId - String
        Returns:
        Comment

      • getProcessInstanceComments

        public static List<org.camunda.bpm.engine.task.Comment> getProcessInstanceComments​(String processInstanceId)
        The comments related to the given process instance.
        Parameters:
        processInstanceId - String
        Returns:
        Lista

      • createAttachment

        public static org.camunda.bpm.engine.task.Attachment createAttachment​(String attachmentType,
                                                                      String taskId,
                                                                      String processInstanceId,
                                                                      String attachmentName,
                                                                      String attachmentDescription,
                                                                      InputStream content)
        Add a new attachment to a task and/or a process instance and use an input stream to provide the content please use method in runtime service to operate on process instance.

        Either taskId or processInstanceId has to be provided

        Parameters:
        attachmentType - - name of the attachment, can be null
        taskId - - task that should have an attachment
        processInstanceId - - id of a process to use if task id is null
        attachmentName - - name of the attachment, can be null
        attachmentDescription - - full text description, can be null
        content - - byte array with content of attachment
        Returns:
        Attachment

      • saveAttachment

        public static void saveAttachment​(org.camunda.bpm.engine.task.Attachment attachment)
        Update the name and decription of an attachment
        Parameters:
        attachment - Attachment

      • getAttachment

        public static org.camunda.bpm.engine.task.Attachment getAttachment​(String attachmentId)
        Retrieve a particular attachment
        Parameters:
        attachmentId - String
        Returns:
        Attachment

      • getTaskAttachment

        public static org.camunda.bpm.engine.task.Attachment getTaskAttachment​(String taskId,
                                                                       String attachmentId)
        Retrieve a particular attachment to the given task id and attachment id
        Parameters:
        taskId - String
        attachmentId - String
        Returns:
        Attachment

      • getAttachmentContent

        public static InputStream getAttachmentContent​(String attachmentId)
        Retrieve stream content of a particular attachment
        Parameters:
        attachmentId - String
        Returns:
        InputStream

      • getTaskAttachmentContent

        public static InputStream getTaskAttachmentContent​(String taskId,
                                                   String attachmentId)
        Retrieve stream content of a particular attachment to the given task id and attachment id
        Parameters:
        taskId - String
        attachmentId - String
        Returns:
        InputStream

      • getTaskAttachments

        public static List<org.camunda.bpm.engine.task.Attachment> getTaskAttachments​(String taskId)
        The list of attachments associated to a task
        Parameters:
        taskId - String
        Returns:
        Lista

      • getProcessInstanceAttachments

        public static List<org.camunda.bpm.engine.task.Attachment> getProcessInstanceAttachments​(String processInstanceId)
        The list of attachments associated to a process instance
        Parameters:
        processInstanceId - String
        Returns:
        InputStream

      • deleteAttachment

        public static void deleteAttachment​(String attachmentId)
        Delete an attachment
        Parameters:
        attachmentId - String

      • deleteTaskAttachment

        public static void deleteTaskAttachment​(String taskId,
                                        String attachmentId)
        Delete an attachment to the given task id and attachment id
        Parameters:
        taskId - String
        attachmentId - String

      • getSubTasks

        public static List<org.camunda.bpm.engine.task.Task> getSubTasks​(String parentTaskId)
        The list of subtasks for this parent task
        Parameters:
        parentTaskId - String
        Returns:
        Lista

      • createTaskReport

        public static org.camunda.bpm.engine.task.TaskReport createTaskReport()
        Instantiate a task report
        Returns:
        TaskReport