Package org.camunda.bpm.engine.task

Interface IdentityLink

  • All Known Implementing Classes:
    IdentityLinkEntity
    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
    Author:
    Joram Barrez

    • 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 getId()
      Get the Id of identityLink
      java.lang.String getProcessDefId()
      Get the process definition id
      java.lang.String getTaskId()
      The id of the task associated with this identity link.
      java.lang.String getTenantId()
      The id of the tenant 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

      • getId

        java.lang.String getId()
        Get the Id of identityLink

      • getType

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

      • 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.

      • getProcessDefId

        java.lang.String getProcessDefId()
        Get the process definition id

      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant associated with this identity link.
        Since:
        7.5