Package org.activiti.engine.task

Interface IdentityLink

  • All Known Subinterfaces:
    IdentityLinkEntity
    All Known Implementing Classes:
    IdentityLinkEntityImpl
    @Internal
public interface IdentityLink
    An identity link is used to associate a task with a certain identity. For example: - a user can be an assignee (= identity link type) for a task - a group can be a candidate-group (= identity link type) for a task

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getGroupId()
      If the identity link involves a group, then this will be a non-null id of a group.
      java.lang.String getProcessDefinitionId()
      The process definition id associated with this identity link.
      java.lang.String getProcessInstanceId()
      The process instance id associated with this identity link.
      java.lang.String getTaskId()
      The id of the task associated with this identity link.
      java.lang.String getType()
      Returns the type of link.
      java.lang.String getUserId()
      If the identity link involves a user, then this will be a non-null id of a user.

    • Method Detail

      • getType

        java.lang.String getType()
        Returns the type of link. See IdentityLinkType for the native supported types by Activiti.

      • getUserId

        java.lang.String getUserId()
        If the identity link involves a user, then this will be a non-null id of a user. That userId can be used to query for user information through the UserQuery API.

      • getGroupId

        java.lang.String getGroupId()
        If the identity link involves a group, then this will be a non-null id of a group. That groupId can be used to query for user information through the GroupQuery API.

      • getTaskId

        java.lang.String getTaskId()
        The id of the task associated with this identity link.

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        The process definition id associated with this identity link.

      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        The process instance id associated with this identity link.