BasicPlatformUser (Flowable Core 3.10.0)

java.lang.Object
- com.flowable.idm.engine.impl.BasicPlatformUser

All Implemented Interfaces:

PlatformUser, Serializable, VariableContainer, User

Direct Known Subclasses:

LdapPlatformUser
```
public class BasicPlatformUser
extends Object
implements PlatformUser, VariableContainer
```
A base implementation of PlatformUser that can be used when implementing a custom PlatformIdentityService

Author:

Filip Hrisafov

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`active`
`protected String`	`avatarId`
`protected Date`	`creationTime`
`protected String`	`creatorId`
`protected String`	`displayName`
`protected String`	`email`
`protected String`	`firstName`
`protected String`	`id`
`protected List<PlatformIdentityInfo>`	`identityInfo`
`protected String`	`language`
`protected String`	`lastName`
`protected String`	`password`
`protected String`	`presence`
`protected Date`	`presenceTime`
`protected String`	`state`
`protected String`	`subState`
`protected String`	`subType`
`protected String`	`tenantId`
`protected String`	`theme`
`protected String`	`type`
`protected String`	`updaterId`
`protected Date`	`updateTime`
`protected String`	`userDefinitionKey`

Constructor Summary

Constructors
Constructor and Description

BasicPlatformUser()

Constructors
Constructor and Description
`BasicPlatformUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`findOrElse(String name, Class<T> clazz, T defaultValue)`
`<T> T`	`findOrElseGet(String name, Class<T> clazz, Supplier<T> defaultValueSupplier)`
`String`	`getAvatarId()` Returns the optional avatar image ID, if this user has an avatar saved in their profile.
`Date`	`getCreationTime()`
`String`	`getCreatorId()`
`String`	`getDisplayName()`
`String`	`getEmail()`
`String`	`getFirstName()`
`String`	`getId()`
`List<PlatformIdentityInfo>`	`getIdentityInfo()` Returns the identity info properties of this user.
`String`	`getLanguage()` Returns the language of this user.
`String`	`getLastName()`
`String`	`getPassword()`
`String`	`getPresence()` Returns the current presence of the user.
`Date`	`getPresenceTime()` The time the current presence of the user was set
`String`	`getState()` Returns the state of this user.
`String`	`getSubState()` Returns the sub state of this user.
`String`	`getSubType()`
`String`	`getTenantId()`
`String`	`getTheme()`
`String`	`getType()` The type of the user.
`String`	`getUpdaterId()`
`Date`	`getUpdateTime()`
`String`	`getUserDefinitionKey()`
`protected <T> T`	`getValue(String name, Class<T> clazz)`
`Object`	`getVariable(String variableName)`
`boolean`	`hasVariable(String variableName)`
`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.
`boolean`	`isPictureSet()`
`void`	`setActive(Boolean active)`
`void`	`setAvatarId(String avatarId)`
`void`	`setCreationTime(Date creationTime)`
`void`	`setCreatorId(String creatorId)`
`void`	`setDisplayName(String displayName)`
`void`	`setEmail(String email)`
`void`	`setFirstName(String firstName)`
`void`	`setId(String id)`
`void`	`setIdentityInfo(List<PlatformIdentityInfo> identityInfo)`
`void`	`setLanguage(String language)`
`void`	`setLastName(String lastName)`
`void`	`setPassword(String password)`
`void`	`setPresence(String presence)`
`void`	`setPresenceTime(Date presenceTime)`
`void`	`setState(String state)`
`void`	`setSubState(String subState)`
`void`	`setSubType(String subType)`
`void`	`setTenantId(String tenantId)`
`void`	`setTheme(String theme)`
`void`	`setTransientVariable(String variableName, Object variableValue)`
`void`	`setType(String type)`
`void`	`setUpdaterId(String updaterId)`
`void`	`setUpdateTime(Date updateTime)`
`void`	`setUserDefinitionKey(String userDefinitionKey)`
`void`	`setVariable(String variableName, Object variableValue)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.flowable.core.idm.api.PlatformUser
findString, isBot, isExternalUser

- Field Detail
  - id
```
protected String id
```
  - firstName
```
protected String firstName
```
  - lastName
```
protected String lastName
```
  - displayName
```
protected String displayName
```
  - email
```
protected String email
```
  - tenantId
```
protected String tenantId
```
  - active
```
protected Boolean active
```
  - avatarId
```
protected String avatarId
```
  - state
```
protected String state
```
  - subState
```
protected String subState
```
  - type
```
protected String type
```
  - subType
```
protected String subType
```
  - userDefinitionKey
```
protected String userDefinitionKey
```
  - language
```
protected String language
```
  - theme
```
protected String theme
```
  - presence
```
protected String presence
```
  - presenceTime
```
protected Date presenceTime
```
  - creatorId
```
protected String creatorId
```
  - creationTime
```
protected Date creationTime
```
  - updaterId
```
protected String updaterId
```
  - updateTime
```
protected Date updateTime
```
  - password
```
protected String password
```
  - identityInfo
```
protected List<PlatformIdentityInfo> identityInfo
```
- Constructor Detail
  - BasicPlatformUser
```
public BasicPlatformUser()
```
- Method Detail
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface User
  - setId
```
public void setId(String id)
```
    Specified by:
    
    setId in interface User
  - getFirstName
```
public String getFirstName()
```
    Specified by:
    
    getFirstName in interface User
  - setFirstName
```
public void setFirstName(String firstName)
```
    Specified by:
    
    setFirstName in interface User
  - getLastName
```
public String getLastName()
```
    Specified by:
    
    getLastName in interface User
  - setLastName
```
public void setLastName(String lastName)
```
    Specified by:
    
    setLastName in interface User
  - getDisplayName
```
public String getDisplayName()
```
    Specified by:
    
    getDisplayName in interface User
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Specified by:
    
    setDisplayName in interface User
  - getEmail
```
public String getEmail()
```
    Specified by:
    
    getEmail in interface User
  - setEmail
```
public void setEmail(String email)
```
    Specified by:
    
    setEmail in interface User
  - isActive
```
public boolean isActive()
```
    Description copied from interface: PlatformUser
    
    Returns true if this user is active, false if it is deactivated, null if cannot be determined because the state field is not available.
    
    Specified by:
    
    isActive in interface PlatformUser
    
    Returns:
    
    true if this user is active
  - setActive
```
public void setActive(Boolean active)
```
  - getTenantId
```
public String getTenantId()
```
    Specified by:
    
    getTenantId in interface VariableContainer
    
    Specified by:
    
    getTenantId in interface User
  - setTenantId
```
public void setTenantId(String tenantId)
```
    Specified by:
    
    setTenantId in interface User
  - getAvatarId
```
public String getAvatarId()
```
    Description copied from interface: PlatformUser
    
    Returns the optional avatar image ID, if this user has an avatar saved in their profile. This can be a content item ID
    
    Specified by:
    
    getAvatarId in interface PlatformUser
    
    Returns:
    
    the optional avatar image ID
  - setAvatarId
```
public void setAvatarId(String avatarId)
```
  - getState
```
public String getState()
```
    Description copied from interface: PlatformUser
    
    Returns the state of this user.
    
    Specified by:
    
    getState in interface PlatformUser
    
    Returns:
    
    the state
  - setState
```
public void setState(String state)
```
  - getSubState
```
public String getSubState()
```
    Description copied from interface: PlatformUser
    
    Returns the sub state of this user.
    
    Specified by:
    
    getSubState in interface PlatformUser
    
    Returns:
    
    the sub state
  - setSubState
```
public void setSubState(String subState)
```
  - getType
```
public String getType()
```
    Description copied from interface: PlatformUser
    
    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.
    
    Specified by:
    
    getType in interface PlatformUser
    
    Returns:
    
    the type of the user
    
    See Also:
    
    for known types
  - setType
```
public void setType(String type)
```
  - getSubType
```
public String getSubType()
```
    Specified by:
    
    getSubType in interface PlatformUser
  - setSubType
```
public void setSubType(String subType)
```
  - getUserDefinitionKey
```
public String getUserDefinitionKey()
```
    Specified by:
    
    getUserDefinitionKey in interface PlatformUser
  - setUserDefinitionKey
```
public void setUserDefinitionKey(String userDefinitionKey)
```
  - getLanguage
```
public String getLanguage()
```
    Description copied from interface: PlatformUser
    
    Returns the language of this user.
    
    Specified by:
    
    getLanguage in interface PlatformUser
    
    Returns:
    
    the language
  - setLanguage
```
public void setLanguage(String language)
```
  - getTheme
```
public String getTheme()
```
    Specified by:
    
    getTheme in interface PlatformUser
  - setTheme
```
public void setTheme(String theme)
```
  - getPresence
```
public String getPresence()
```
    Description copied from interface: PlatformUser
    
    Returns the current presence of the user.
    
    Specified by:
    
    getPresence in interface PlatformUser
    
    Returns:
    
    the presence of the user
    
    See Also:
    
    for known states
  - setPresence
```
public void setPresence(String presence)
```
  - getPresenceTime
```
public Date getPresenceTime()
```
    Description copied from interface: PlatformUser
    
    The time the current presence of the user was set
    
    Specified by:
    
    getPresenceTime in interface PlatformUser
    
    Returns:
    
    the time the presence of the user was set
  - setPresenceTime
```
public void setPresenceTime(Date presenceTime)
```
  - getCreatorId
```
public String getCreatorId()
```
    Specified by:
    
    getCreatorId in interface PlatformUser
  - setCreatorId
```
public void setCreatorId(String creatorId)
```
  - getCreationTime
```
public Date getCreationTime()
```
    Specified by:
    
    getCreationTime in interface PlatformUser
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
  - getUpdaterId
```
public String getUpdaterId()
```
    Specified by:
    
    getUpdaterId in interface PlatformUser
  - setUpdaterId
```
public void setUpdaterId(String updaterId)
```
  - getUpdateTime
```
public Date getUpdateTime()
```
    Specified by:
    
    getUpdateTime in interface PlatformUser
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
  - getIdentityInfo
```
public List<PlatformIdentityInfo> getIdentityInfo()
```
    Description copied from interface: PlatformUser
    
    Returns the identity info properties of this user.
    
    Specified by:
    
    getIdentityInfo in interface PlatformUser
    
    Returns:
    
    the identity info properties
  - setIdentityInfo
```
public void setIdentityInfo(List<PlatformIdentityInfo> identityInfo)
```
  - findOrElseGet
```
public <T> T findOrElseGet(String name,
                           Class<T> clazz,
                           Supplier<T> defaultValueSupplier)
```
    Specified by:
    
    findOrElseGet in interface PlatformUser
  - findOrElse
```
public <T> T findOrElse(String name,
                        Class<T> clazz,
                        T defaultValue)
```
    Specified by:
    
    findOrElse in interface PlatformUser
  - getValue
```
protected <T> T getValue(String name,
                         Class<T> clazz)
```
  - getPassword
```
public String getPassword()
```
    Specified by:
    
    getPassword in interface User
  - setPassword
```
public void setPassword(String password)
```
    Specified by:
    
    setPassword in interface User
  - isPictureSet
```
public boolean isPictureSet()
```
    Specified by:
    
    isPictureSet in interface User
  - hasVariable
```
public boolean hasVariable(String variableName)
```
    Specified by:
    
    hasVariable in interface VariableContainer
  - getVariable
```
public Object getVariable(String variableName)
```
    Specified by:
    
    getVariable in interface VariableContainer
  - setVariable
```
public void setVariable(String variableName,
                        Object variableValue)
```
    Specified by:
    
    setVariable in interface VariableContainer
  - setTransientVariable
```
public void setTransientVariable(String variableName,
                                 Object variableValue)
```
    Specified by:
    
    setTransientVariable in interface VariableContainer

Class BasicPlatformUser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.flowable.core.idm.api.PlatformUser

Field Detail

id

firstName

lastName

displayName

email

tenantId

active

avatarId

state

subState

type

subType

userDefinitionKey

language

theme

presence

presenceTime

creatorId

creationTime

updaterId

updateTime

password

identityInfo

Constructor Detail

BasicPlatformUser

Method Detail

getId

setId

getFirstName

setFirstName

getLastName

setLastName

getDisplayName

setDisplayName

getEmail

setEmail

isActive

setActive

getTenantId

setTenantId

getAvatarId

setAvatarId

getState

setState

getSubState

setSubState

getType

setType

getSubType

setSubType

getUserDefinitionKey

setUserDefinitionKey

getLanguage

setLanguage

getTheme

setTheme

getPresence

setPresence

getPresenceTime

setPresenceTime

getCreatorId

setCreatorId

getCreationTime

setCreationTime

getUpdaterId

setUpdaterId

getUpdateTime

setUpdateTime

getIdentityInfo

setIdentityInfo

findOrElseGet

findOrElse

getValue