Package org.flowable.task.service.delegate

Interface DelegateTask

All Superinterfaces:
VariableContainer, VariableScope
All Known Subinterfaces:
TaskEntity
All Known Implementing Classes:
TaskEntityImpl
public interface DelegateTask extends VariableScope
Author:
Joram Barrez

  • Method Details

    • getId

      String getId()
      DB id of the task.

    • getName

      String getName()
      Name or title of the task.

    • setName

      void setName(String name)
      Change the name of the task.

    • getDescription

      String getDescription()
      Free text description of the task.

    • setDescription

      void setDescription(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

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

    • getExecutionId

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

    • getProcessDefinitionId

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

    • getState

      String getState()
      The current state of the task.

    • getCreateTime

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

    • getInProgressStartTime

      Date getInProgressStartTime()
      The date/time when this task was put in progress

    • getInProgressStartedBy

      String getInProgressStartedBy()
      The user reference that started the task.

    • getClaimTime

      Date getClaimTime()
      The date/time when this task was claimed

    • getClaimedBy

      String getClaimedBy()
      The user reference that claimed the task.

    • getSuspendedTime

      Date getSuspendedTime()
      The date/time when this task was suspended

    • getSuspendedBy

      String getSuspendedBy()
      The user reference that suspended the task.

    • getTaskDefinitionKey

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

    • isSuspended

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

    • getTenantId

      String getTenantId()
      The tenant identifier of this task
      Specified by:
      getTenantId in interface VariableContainer

    • getFormKey

      String getFormKey()
      The form key for the user task

    • setFormKey

      void setFormKey(String formKey)
      Change the form key of the task

    • getEventName

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

    • getEventHandlerId

      String getEventHandlerId()
      Returns the event handler identifier which triggered the task listener to fire for this task.

    • getDelegationState

      DelegationState getDelegationState()
      The current DelegationState for this task.

    • addCandidateUser

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

    • addCandidateUsers

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

    • addCandidateGroup

      void addCandidateGroup(String groupId)
      Adds the given group as candidate group to this task

    • addCandidateGroups

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

    • getOwner

      String getOwner()
      The user id of the person responsible for this task.

    • setOwner

      void setOwner(String owner)
      The user id of the person responsible for this task.

    • getAssignee

      String getAssignee()
      The user id of the person to which this task is delegated.

    • setAssignee

      void setAssignee(String assignee)
      The user id of the person to which this task is delegated.

    • getInProgressStartDueDate

      Date getInProgressStartDueDate()
      Due date of the in progress start of the task.

    • setInProgressStartDueDate

      void setInProgressStartDueDate(Date inProgressStartDueDate)
      Change the in progress start due date of the task.

    • getDueDate

      Date getDueDate()
      Due date of the task.

    • setDueDate

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

    • getCategory

      String getCategory()
      The category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.

    • setCategory

      void setCategory(String category)
      Change the category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.

    • addUserIdentityLink

      void addUserIdentityLink(String userId, 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:
      FlowableObjectNotFoundException - when the task or user doesn't exist.

    • addGroupIdentityLink

      void addGroupIdentityLink(String groupId, 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:
      FlowableObjectNotFoundException - when the task or group doesn't exist.

    • deleteCandidateUser

      void deleteCandidateUser(String userId)
      Convenience shorthand for deleteUserIdentityLink(String, String) ; with type IdentityLinkType.CANDIDATE
      Parameters:
      userId - id of the user to use as candidate, cannot be null.
      Throws:
      FlowableObjectNotFoundException - when the task or user doesn't exist.

    • deleteCandidateGroup

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

    • deleteUserIdentityLink

      void deleteUserIdentityLink(String userId, 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:
      FlowableObjectNotFoundException - when the task or user doesn't exist.

    • deleteGroupIdentityLink

      void deleteGroupIdentityLink(String groupId, 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:
      FlowableObjectNotFoundException - when the task or group doesn't exist.

    • getCandidates

      Set<IdentityLink> getCandidates()
      Retrieves the candidate users and groups associated with the task.
      Returns:
      set of IdentityLinks of type IdentityLinkType.CANDIDATE.