Interface Task

  • All Known Implementing Classes:
    TaskEntity

    public interface Task
    Represents one task for a human user.
    Author:
    Joram Barrez
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delegate​(java.lang.String userId)
      delegates this task to the given user and sets the delegationState to DelegationState.PENDING.
      java.lang.String getAssignee()
      The userId of the person to which this task is assigned or delegated.
      CamundaFormRef getCamundaFormRef()
      Provides the form binding reference to the Camunda Form for the task.
      java.lang.String getCaseDefinitionId()
      Reference to the case definition or null if it is not related to a case.
      java.lang.String getCaseExecutionId()
      Reference to the path of case execution or null if it is not related to a case instance.
      java.lang.String getCaseInstanceId()
      Reference to the case instance or null if it is not related to a case instance.
      java.util.Date getCreateTime()
      The date/time when this task was created
      DelegationState getDelegationState()
      The current DelegationState for this task.
      java.lang.String getDescription()
      Free text description of the task.
      java.util.Date getDueDate()
      Due date of the task.
      java.lang.String getExecutionId()
      Reference to the path of execution or null if it is not related to a process instance.
      java.util.Date getFollowUpDate()
      Follow-up date of the task.
      java.lang.String getFormKey()
      Provides the form key for the task.
      java.lang.String getId()
      DB id of the task.
      java.lang.String getName()
      Name or title of the task.
      java.lang.String getOwner()
      The userId of the person that is responsible for this task.
      java.lang.String getParentTaskId()
      the parent task for which this task is a subtask
      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
      java.lang.String getProcessDefinitionId()
      Reference to the process definition or null if it is not related to a process.
      java.lang.String getProcessInstanceId()
      Reference to the process instance or null if it is not related to a process instance.
      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
      java.lang.String getTenantId()
      Returns the task's tenant id or null in case this task does not belong to a tenant.
      boolean isSuspended()
      Indicated whether this task is suspended or not.
      void setAssignee​(java.lang.String assignee)
      The userId of the person to which this task is assigned or delegated.
      void setCaseInstanceId​(java.lang.String caseInstanceId)
      The case instance id for which this task is associated for.
      void setDelegationState​(DelegationState delegationState)
      The current DelegationState for this task.
      void setDescription​(java.lang.String description)
      Change the description of the task
      void setDueDate​(java.util.Date dueDate)
      Change due date of the task.
      void setFollowUpDate​(java.util.Date followUpDate)
      Change follow-up date of the task.
      void setName​(java.lang.String name)
      Name or title of the task.
      void setOwner​(java.lang.String owner)
      The userId of the person that is responsible for this task.
      void setParentTaskId​(java.lang.String parentTaskId)
      the parent task for which this task is a subtask
      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
      void setTenantId​(java.lang.String tenantId)
      Sets the tenant id for this task.
    • 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)
        Name or title 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
      • getOwner

        java.lang.String getOwner()
        The userId of the person that is responsible for this task. This is used when a task is delegated.
      • setOwner

        void setOwner​(java.lang.String owner)
        The userId of the person that is responsible for this task. This is used when a task is delegated.
      • getAssignee

        java.lang.String getAssignee()
        The userId of the person to which this task is assigned or delegated.
      • setAssignee

        void setAssignee​(java.lang.String assignee)
        The userId of the person to which this task is assigned or delegated.
      • 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.
      • setCaseInstanceId

        void setCaseInstanceId​(java.lang.String caseInstanceId)
        The case instance id for which this task is associated for.
      • getCaseExecutionId

        java.lang.String getCaseExecutionId()
        Reference to the path of 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
      • getDueDate

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

        void setDueDate​(java.util.Date dueDate)
        Change due date of the task.
      • 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.
      • delegate

        void delegate​(java.lang.String userId)
        delegates this task to the given user and sets the delegationState to DelegationState.PENDING. If no owner is set on the task, the owner is set to the current assignee of the task.
      • setParentTaskId

        void setParentTaskId​(java.lang.String parentTaskId)
        the parent task for which this task is a subtask
      • getParentTaskId

        java.lang.String getParentTaskId()
        the parent task for which this task is a subtask
      • isSuspended

        boolean isSuspended()
        Indicated whether this task is suspended or not.
      • getTenantId

        java.lang.String getTenantId()
        Returns the task's tenant id or null in case this task does not belong to a tenant.
        Returns:
        the task's tenant id or null
        Since:
        7.5
      • setTenantId

        void setTenantId​(java.lang.String tenantId)
        Sets the tenant id for this task.
        Parameters:
        tenantId - the tenant id to set
        Since:
        7.5