Package com.flowable.core.idm.api

Interface PlatformUser

All Superinterfaces:

Serializable, User

All Known Subinterfaces:

PlatformUserEntity

All Known Implementing Classes:

BasicPlatformUser, LdapPlatformUser, PlatformUserEntityImpl

public interface PlatformUser
extends User

Author:

Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
<T> T	findOrElse(String name, Class<T> clazz, T defaultValue)
<T> T	findOrElseGet(String name, Class<T> clazz, Supplier<T> defaultValueSupplier)
default String	findString(String name)	Find a string info with the given name.
String	getAvatarId()	Returns the optional avatar image ID, if this user has an avatar saved in their profile.
Date	getCreationTime()
String	getCreatorId()
List<PlatformIdentityInfo>	getIdentityInfo()	Returns the identity info properties of this user.
String	getLanguage()	Returns the language of this user.
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	getTheme()
String	getType()	The type of the user.
String	getUpdaterId()
Date	getUpdateTime()
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 Detail

getType

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

String getSubType()

getUserDefinitionKey

String getUserDefinitionKey()

getCreatorId

String getCreatorId()

getCreationTime

Date getCreationTime()

getUpdaterId

String getUpdaterId()

getUpdateTime

Date getUpdateTime()

getState

String getState()

Returns the state of this user.

Returns:

the state

getSubState

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

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

String getPresence()

Returns the current presence of the user.

Returns:

the presence of the user

See Also:

for known states

getPresenceTime

Date getPresenceTime()

The time the current presence of the user was set

Returns:

the time the presence of the user was set

getLanguage

String getLanguage()

Returns the language of this user.

Returns:

the language

getTheme

String getTheme()

getIdentityInfo

List<PlatformIdentityInfo> getIdentityInfo()

Returns the identity info properties of this user.

Returns:

the identity info properties

findOrElseGet

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

findOrElse

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

findString

default String findString(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