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

    Modifier and Type
    Method
    Description
    String
    getGroupId()
    If the identity link involves a group, then this will be a non-null id of a group.
    String
    getId()
    Get the Id of identityLink
    String
    getProcessDefId()
    Get the process definition id
    String
    getTaskId()
    The id of the task associated with this identity link.
    String
    getTenantId()
    The id of the tenant associated with this identity link.
    String
    getType()
    Returns the type of link.
    String
    getUserId()
    If the identity link involves a user, then this will be a non-null id of a user.

  • Method Details

    • getId

      String getId()
      Get the Id of identityLink

    • getType

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

    • getUserId

      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

      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

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

    • getProcessDefId

      String getProcessDefId()
      Get the process definition id

    • getTenantId

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