Package com.flowable.core.idm.api

Interface PlatformUser

All Superinterfaces:
java.io.Serializable, org.flowable.idm.api.User
All Known Subinterfaces:
PlatformUserEntity
All Known Implementing Classes:
BasicPlatformUser, LdapPlatformUser, PlatformUserEntityImpl
public interface PlatformUser
extends org.flowable.idm.api.User
Author:
Filip Hrisafov

  • Method Summary

    Modifier and Type Method Description
    <T> T findOrElse​(java.lang.String name, java.lang.Class<T> clazz, T defaultValue)  
    <T> T findOrElseGet​(java.lang.String name, java.lang.Class<T> clazz, java.util.function.Supplier<T> defaultValueSupplier)  
    default java.lang.String findString​(java.lang.String name)
    Find a string info with the given name.
    java.lang.String getAvatarId()
    Returns the optional avatar image ID, if this user has an avatar saved in their profile.
    java.util.Date getCreationTime()  
    java.lang.String getCreatorId()  
    java.util.List<PlatformIdentityInfo> getIdentityInfo()
    Returns the identity info properties of this user.
    java.lang.String getLanguage()
    Returns the language of this user.
    java.lang.String getPresence()
    Returns the current presence of the user.
    java.util.Date getPresenceTime()
    The time the current presence of the user was set
    java.lang.String getState()
    Returns the state of this user.
    java.lang.String getSubState()
    Returns the sub state of this user.
    java.lang.String getSubType()  
    java.lang.String getTheme()  
    java.lang.String getType()
    The type of the user.
    java.lang.String getUpdaterId()  
    java.util.Date getUpdateTime()  
    java.lang.String getUserDefinitionKey()  
    default boolean isActive()
    Returns true if this user is active, false if it is deactivated, null if cannot be determined because the state field is not available.
    default boolean isBot()
    Helper method for checking that the user is of type UserTypes.BOT
    default boolean isExternalUser()
    Helper method for checking that the user is of type UserTypes.EXTERNAL

    Methods inherited from interface org.flowable.idm.api.User

    getDisplayName, getEmail, getFirstName, getId, getLastName, getPassword, getTenantId, isPictureSet, setDisplayName, setEmail, setFirstName, setId, setLastName, setPassword, setTenantId

  • Method Details

    • getType

      java.lang.String getType()
      The type of the user. It is possible that a user does not have this set, in this case this is a normal non special user.
      Returns:
      the type of the user
      See Also:
      for known types

    • getSubType

      java.lang.String getSubType()

    • getUserDefinitionKey

      java.lang.String getUserDefinitionKey()

    • getCreatorId

      java.lang.String getCreatorId()

    • getCreationTime

      java.util.Date getCreationTime()

    • getUpdaterId

      java.lang.String getUpdaterId()

    • getUpdateTime

      java.util.Date getUpdateTime()

    • getState

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

    • getSubState

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

    • isActive

      default boolean isActive()
      Returns true if this user is active, false if it is deactivated, null if cannot be determined because the state field is not available.
      Returns:
      true if this user is active

    • getAvatarId

      java.lang.String getAvatarId()
      Returns the optional avatar image ID, if this user has an avatar saved in their profile. This can be a content item ID
      Returns:
      the optional avatar image ID

    • getPresence

      java.lang.String getPresence()
      Returns the current presence of the user.
      Returns:
      the presence of the user
      See Also:
      for known states

    • getPresenceTime

      java.util.Date getPresenceTime()
      The time the current presence of the user was set
      Returns:
      the time the presence of the user was set

    • getLanguage

      java.lang.String getLanguage()
      Returns the language of this user.
      Returns:
      the language

    • getTheme

      java.lang.String getTheme()

    • getIdentityInfo

      java.util.List<PlatformIdentityInfo> getIdentityInfo()
      Returns the identity info properties of this user.
      Returns:
      the identity info properties

    • findOrElseGet

      <T> T findOrElseGet​(java.lang.String name, java.lang.Class<T> clazz, java.util.function.Supplier<T> defaultValueSupplier)

    • findOrElse

      <T> T findOrElse​(java.lang.String name, java.lang.Class<T> clazz, T defaultValue)

    • findString

      default java.lang.String findString​(java.lang.String name)
      Find a string info with the given name.
      Parameters:
      name - the name of the info
      Returns:
      the value for the given name, or null if such info does not exist

    • isExternalUser

      default boolean isExternalUser()
      Helper method for checking that the user is of type UserTypes.EXTERNAL
      Returns:
      true if the user is of type UserTypes.EXTERNAL, false otherwise

    • isBot

      default boolean isBot()
      Helper method for checking that the user is of type UserTypes.BOT
      Returns:
      true if the user is of type UserTypes.BOT, false otherwise