Package org.camunda.bpm.engine.delegate

Interface DelegateTask

    • Method Detail

      • getId

        java.lang.String getId()
        DB id of the task.

      • getName

        java.lang.String getName()
        Name or title of the task.

      • setName

        void setName​(java.lang.String name)
        Change the name of the task.

      • getDescription

        java.lang.String getDescription()
        Free text description of the task.

      • setDescription

        void setDescription​(java.lang.String description)
        Change the description of the task

      • getPriority

        int getPriority()
        indication of how important/urgent this task is with a number between 0 and 100 where higher values mean a higher priority and lower values mean lower priority: [0..19] lowest, [20..39] low, [40..59] normal, [60..79] high [80..100] highest

      • setPriority

        void setPriority​(int priority)
        indication of how important/urgent this task is with a number between 0 and 100 where higher values mean a higher priority and lower values mean lower priority: [0..19] lowest, [20..39] low, [40..59] normal, [60..79] high [80..100] highest

      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        Reference to the process instance or null if it is not related to a process instance.

      • getExecutionId

        java.lang.String getExecutionId()
        Reference to the path of execution or null if it is not related to a process instance.

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        Reference to the process definition or null if it is not related to a process.

      • getCaseInstanceId

        java.lang.String getCaseInstanceId()
        Reference to the case instance or null if it is not related to a case instance.

      • getCaseExecutionId

        java.lang.String getCaseExecutionId()
        Reference to the case execution or null if it is not related to a case instance.

      • getCaseDefinitionId

        java.lang.String getCaseDefinitionId()
        Reference to the case definition or null if it is not related to a case.

      • getCreateTime

        java.util.Date getCreateTime()
        The date/time when this task was created

      • getTaskDefinitionKey

        java.lang.String getTaskDefinitionKey()
        The id of the activity in the process defining this task or null if this is not related to a process

      • getExecution

        DelegateExecution getExecution()
        Returns the execution currently at the task.

      • getCaseExecution

        DelegateCaseExecution getCaseExecution()
        Returns the case execution currently at the task.

      • getEventName

        java.lang.String getEventName()
        Returns the event name which triggered the task listener to fire for this task.

      • addCandidateUser

        void addCandidateUser​(java.lang.String userId)
        Adds the given user as a candidate user to this task.

      • addCandidateUsers

        void addCandidateUsers​(java.util.Collection<java.lang.String> candidateUsers)
        Adds multiple users as candidate user to this task.

      • addCandidateGroup

        void addCandidateGroup​(java.lang.String groupId)
        Adds the given group as candidate group to this task

      • addCandidateGroups

        void addCandidateGroups​(java.util.Collection<java.lang.String> candidateGroups)
        Adds multiple groups as candidate group to this task.

      • getOwner

        java.lang.String getOwner()
        The {@link User.getId() userId} of the person responsible for this task.

      • setOwner

        void setOwner​(java.lang.String owner)
        The {@link User.getId() userId} of the person responsible for this task.

      • getAssignee

        java.lang.String getAssignee()
        The {@link User.getId() userId} of the person to which this task is delegated.

      • setAssignee

        void setAssignee​(java.lang.String assignee)
        The {@link User.getId() userId} of the person to which this task is delegated.

      • getDueDate

        java.util.Date getDueDate()
        Due date of the task.

      • setDueDate

        void setDueDate​(java.util.Date dueDate)
        Change due date of the task.

      • getDeleteReason

        java.lang.String getDeleteReason()
        Get delete reason of the task.

      • addUserIdentityLink

        void addUserIdentityLink​(java.lang.String userId,
                         java.lang.String identityLinkType)
        Involves a user with a task. The type of identity link is defined by the given identityLinkType.
        Parameters:
        userId - id of the user involve, cannot be null.
        identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
        Throws:
        ProcessEngineException - when the task or user doesn't exist.

      • addGroupIdentityLink

        void addGroupIdentityLink​(java.lang.String groupId,
                          java.lang.String identityLinkType)
        Involves a group with group task. The type of identityLink is defined by the given identityLink.
        Parameters:
        groupId - id of the group to involve, cannot be null.
        identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
        Throws:
        ProcessEngineException - when the task or group doesn't exist.

      • deleteCandidateGroup

        void deleteCandidateGroup​(java.lang.String groupId)
        Convenience shorthand for #deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE
        Parameters:
        groupId - id of the group to use as candidate, cannot be null.
        Throws:
        ProcessEngineException - when the task or group doesn't exist.

      • deleteUserIdentityLink

        void deleteUserIdentityLink​(java.lang.String userId,
                            java.lang.String identityLinkType)
        Removes the association between a user and a task for the given identityLinkType.
        Parameters:
        userId - id of the user involve, cannot be null.
        identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
        Throws:
        ProcessEngineException - when the task or user doesn't exist.

      • deleteGroupIdentityLink

        void deleteGroupIdentityLink​(java.lang.String groupId,
                             java.lang.String identityLinkType)
        Removes the association between a group and a task for the given identityLinkType.
        Parameters:
        groupId - id of the group to involve, cannot be null.
        identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
        Throws:
        ProcessEngineException - when the task or group doesn't exist.

      • getTenantId

        java.lang.String getTenantId()
        Return the id of the tenant this task belongs to. Can be null if the task belongs to no single tenant.

      • getFollowUpDate

        java.util.Date getFollowUpDate()
        Follow-up date of the task.

      • setFollowUpDate

        void setFollowUpDate​(java.util.Date followUpDate)
        Change follow-up date of the task.

      • complete

        void complete()
        set status to complete.
        Throws:
        java.lang.IllegalStateException - if performed on completion or deletion