Package com.flowable.idm.engine.impl.persistence.entity

Class PlatformUserEntityImpl

java.lang.Object

org.flowable.common.engine.impl.persistence.entity.AbstractEntity

com.flowable.idm.engine.impl.persistence.entity.AbstractIdmEngineEntity

com.flowable.idm.engine.impl.persistence.entity.PlatformUserEntityImpl

All Implemented Interfaces:

PlatformUser, PlatformUserEntity, Serializable, VariableContainer, HasRevision, Entity, User

public class PlatformUserEntityImpl
extends AbstractIdmEngineEntity
implements PlatformUserEntity

Author:

Tom Baeyens, Arkadiy Gornovoy, Joram Barrez, Filip Hrisafov

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	avatarId
protected Date	creationTime
protected String	creatorId
protected String	displayName
protected String	email
protected String	firstName
protected List<PlatformIdentityInfo>	identityInfo	The identity info for the user.
protected boolean	identityInfoInitialized
protected String	lastName
protected String	password
protected String	tenantId
protected String	updaterId
protected Date	updateTime

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Constructor Summary

Constructors

Constructor	Description
PlatformUserEntityImpl()

Method Summary

Modifier and Type	Method	Description
protected PlatformIdentityInfoEntity	addIdentityInfo(String name, Object value)
PlatformIdentityInfoEntity	findIdentityInfo(String name)
<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()
List<PlatformIdentityInfo>	getIdentityInfo()	Returns the identity info properties of this user.
String	getLanguage()	Returns the language of this user.
String	getLastName()
String	getPassword()
Object	getPersistentState()
String	getPresence()	Returns the current presence of the user.
Date	getPresenceTime()	The time the current presence of the user was set
List<PlatformIdentityInfo>	getQueryIdentityInfo()	Getter used by MyBatis when querying platform user with identity info included.
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)
boolean	hasVariable(String variableName)
boolean	isIdentityInfoInitialized()
boolean	isPictureSet()
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	setIdentityInfo(String name, Object value)
void	setIdentityInfo(List<PlatformIdentityInfo> identityInfo)
void	setLanguage(String language)
void	setLastName(String lastName)
void	setPassword(String password)
void	setPresence(String presence)
void	setQueryIdentityInfo(List<PlatformIdentityInfo> queryIdentityInfo)	Setter used by MyBatis when querying conversation with identity links.
void	setState(String state)	Set the new state for this user.
void	setSubState(String subState)	Set the new sub state for this user.
void	setSubType(String subType)
void	setTenantId(String tenantId)
void	setTheme(String theme)
void	setType(String type)
void	setUpdaterId(String updaterId)
void	setUpdateTime(Date updateTime)
void	setUserDefinitionKey(String userDefinitionKey)
String	toString()

Methods inherited from class com.flowable.idm.engine.impl.persistence.entity.AbstractIdmEngineEntity

getIdPrefix

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

getRevision, getRevisionNext, setRevision

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

findString, isActive, isBot, isExternalUser

Methods inherited from interface com.flowable.idm.engine.impl.persistence.entity.PlatformUserEntity

getVariable, setTransientVariable, setVariable

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

getId, setId

Field Details

firstName

protected String firstName

lastName

protected String lastName

displayName

protected String displayName

avatarId

protected String avatarId

email

protected String email

creatorId

protected String creatorId

creationTime

protected Date creationTime

updaterId

protected String updaterId

updateTime

protected Date updateTime

password

protected String password

tenantId

protected String tenantId

identityInfoInitialized

protected boolean identityInfoInitialized

identityInfo

protected List<PlatformIdentityInfo> identityInfo

The identity info for the user. Make sure that it is not set otherwise MyBatis won't invoke the setter.

Constructor Details

PlatformUserEntityImpl

public PlatformUserEntityImpl()

Method Details

getPersistentState

public Object getPersistentState()

Specified by:

getPersistentState in interface Entity

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)

Specified by:

setType in interface PlatformUserEntity

getSubType

public String getSubType()

Specified by:

getSubType in interface PlatformUser

setSubType

public void setSubType(String subType)

Specified by:

setSubType in interface PlatformUserEntity

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)

Description copied from interface: PlatformUserEntity

Set the new state for this user. This should only be done over a deactivation / reactivation method and not as part of an user update.

Specified by:

setState in interface PlatformUserEntity

Parameters:

state - the state to be set for this user (ACTIVE or INACTIVE)

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)

Description copied from interface: PlatformUserEntity

Set the new sub state for this user.

Specified by:

setSubState in interface PlatformUserEntity

Parameters:

subState - the sub state to be set for this 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

getUserDefinitionKey

public String getUserDefinitionKey()

Specified by:

getUserDefinitionKey in interface PlatformUser

setUserDefinitionKey

public void setUserDefinitionKey(String userDefinitionKey)

Specified by:

setUserDefinitionKey in interface PlatformUserEntity

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)

Specified by:

setAvatarId in interface PlatformUserEntity

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)

Specified by:

setPresence in interface PlatformUserEntity

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

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)

Specified by:

setLanguage in interface PlatformUserEntity

getTheme

public String getTheme()

Specified by:

getTheme in interface PlatformUser

setTheme

public void setTheme(String theme)

Specified by:

setTheme in interface PlatformUserEntity

getEmail

public String getEmail()

Specified by:

getEmail in interface User

setEmail

public void setEmail(String email)

Specified by:

setEmail in interface User

getCreatorId

public String getCreatorId()

Specified by:

getCreatorId in interface PlatformUser

setCreatorId

public void setCreatorId(String creatorId)

Specified by:

setCreatorId in interface PlatformUserEntity

getCreationTime

public Date getCreationTime()

Specified by:

getCreationTime in interface PlatformUser

setCreationTime

public void setCreationTime(Date creationTime)

Specified by:

setCreationTime in interface PlatformUserEntity

getUpdaterId

public String getUpdaterId()

Specified by:

getUpdaterId in interface PlatformUser

setUpdaterId

public void setUpdaterId(String updaterId)

Specified by:

setUpdaterId in interface PlatformUserEntity

getUpdateTime

public Date getUpdateTime()

Specified by:

getUpdateTime in interface PlatformUser

setUpdateTime

public void setUpdateTime(Date updateTime)

Specified by:

setUpdateTime in interface PlatformUserEntity

getPassword

public String getPassword()

Specified by:

getPassword in interface User

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface User

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface User

Specified by:

getTenantId in interface VariableContainer

setTenantId

public void setTenantId(String tenantId)

Specified by:

setTenantId in interface User

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)

Specified by:

setIdentityInfo in interface PlatformUserEntity

setIdentityInfo

public void setIdentityInfo(String name,
 Object value)

Specified by:

setIdentityInfo in interface PlatformUserEntity

addIdentityInfo

protected PlatformIdentityInfoEntity addIdentityInfo(String name,
 Object value)

getQueryIdentityInfo

public List<PlatformIdentityInfo> getQueryIdentityInfo()

Getter used by MyBatis when querying platform user with identity info included.

setQueryIdentityInfo

public void setQueryIdentityInfo(List<PlatformIdentityInfo> queryIdentityInfo)

Setter used by MyBatis when querying conversation with identity links.

isPictureSet

public boolean isPictureSet()

Specified by:

isPictureSet in interface User

isIdentityInfoInitialized

public boolean isIdentityInfoInitialized()

Specified by:

isIdentityInfoInitialized in interface PlatformUserEntity

findIdentityInfo

public PlatformIdentityInfoEntity findIdentityInfo(String name)

Specified by:

findIdentityInfo in interface PlatformUserEntity

findOrElseGet

public <T> T findOrElseGet(String name,
 Class<T> clazz,
 Supplier<T> defaultValueSupplier)

Specified by:

findOrElseGet in interface PlatformUser

Specified by:

findOrElseGet in interface PlatformUserEntity

findOrElse

public <T> T findOrElse(String name,
 Class<T> clazz,
 T defaultValue)

Specified by:

findOrElse in interface PlatformUser

Specified by:

findOrElse in interface PlatformUserEntity

hasVariable

public boolean hasVariable(String variableName)

Specified by:

hasVariable in interface VariableContainer

getValue

protected <T> T getValue(String name,
 Class<T> clazz)

toString

public String toString()

Overrides:

toString in class Object