Package com.flowable.core.idm.api

Interface UserAccount

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.lang.String getBusinessAccountId()
      The id of the business account id this user account is linked to (e.g.
      java.util.Date getCreationTime()
      The time of creation of this account
      java.lang.String getCreatorId()
      The id of the user that created this account
      java.lang.String getExternalUserId()
      The id of the user within the external system (e.g.
      java.lang.String getId()
      The unique id for the user account.
      java.lang.String getName()
      The name of the account.
      java.lang.String getState()
      The state of the user account
      java.lang.String getSubState()
      The sub state of the user account
      java.lang.String getSubType()
      The sub type of the account.
      java.lang.String getTenantId()
      The id of the tenant that this user account belongs to
      java.lang.String getType()
      The type of the account.
      java.lang.String getUpdaterId()
      The id of the user that last updated the account
      java.util.Date getUpdateTime()
      The time of the last update of this account
      java.lang.String getUserAccountDefinitionId()
      The id of the user account definition for this user account
      java.lang.String getUserId()
      The id of the user that this account belongs to.
      default boolean isActive()
      Method to check if this user account has the state ACTIVE.

    • Method Detail

      • getId

        java.lang.String getId()
        The unique id for the user account.
        Returns:
        thd user account id

      • getUserId

        java.lang.String getUserId()
        The id of the user that this account belongs to. It might be null if the account is not yet linked with a user (during onboarding for example).
        Returns:
        the id of the user that this account belongs to

      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant that this user account belongs to
        Returns:
        the tenant id

      • getName

        java.lang.String getName()
        The name of the account. (e.g. WhatsApp for XY, etc)
        Returns:
        the name of the account

      • getType

        java.lang.String getType()
        The type of the account. (e.g. Messenger)
        Returns:
        the type of the account

      • getSubType

        java.lang.String getSubType()
        The sub type of the account. (e.g. WhatsApp, WeChat, Facebook, etc)
        Returns:
        the sub type of the account

      • getState

        java.lang.String getState()
        The state of the user account
        Returns:
        the state

      • getSubState

        java.lang.String getSubState()
        The sub state of the user account
        Returns:
        the sub state

      • getBusinessAccountId

        java.lang.String getBusinessAccountId()
        The id of the business account id this user account is linked to (e.g. WhatsApp business number xyz or WeChat official account, etc).
        Returns:
        the business account id

      • getExternalUserId

        java.lang.String getExternalUserId()
        The id of the user within the external system (e.g. the phone number if it is a WhatsApp account or the user-id for a facebook account, etc)
        Returns:
        external user id

      • getUserAccountDefinitionId

        java.lang.String getUserAccountDefinitionId()
        The id of the user account definition for this user account
        Returns:
        the user account definition id

      • getCreatorId

        java.lang.String getCreatorId()
        The id of the user that created this account
        Returns:
        the id of the creator

      • getCreationTime

        java.util.Date getCreationTime()
        The time of creation of this account
        Returns:
        the creation time of this account

      • getUpdaterId

        java.lang.String getUpdaterId()
        The id of the user that last updated the account
        Returns:
        the id of the user that last updated the account

      • getUpdateTime

        java.util.Date getUpdateTime()
        The time of the last update of this account
        Returns:
        the last update time of this account

      • isActive

        default boolean isActive()
        Method to check if this user account has the state ACTIVE.
        Returns:
        true if this user account has the state ACTIVE, false otherwise