Package com.flowable.core.idm.api

Interface PlatformUserBuilder

All Known Implementing Classes:

PlatformUserBuilderImpl

public interface PlatformUserBuilder

A builder for the Platform user that can be used to set predefined properties or add some custom properties.

Author:

Filip Hrisafov, Joram Barrez

Method Summary

Modifier and Type	Method	Description
PlatformUserBuilder	avatarId(String avatarId)
PlatformUserBuilder	displayName(String displayName)
PlatformUserBuilder	email(String email)
PlatformUserBuilder	firstName(String firstName)
PlatformUserBuilder	language(String language)
PlatformUserBuilder	lastName(String lastName)
PlatformUserBuilder	password(String password)
PlatformUserBuilder	presence(String presence)	Setting the presence is only possible for new users.
PlatformUser	save()	Performs the save of the user
PlatformUserBuilder	setInfo(String name, Object value)
PlatformUserBuilder	state(String state)
PlatformUserBuilder	subState(String subState)
PlatformUserBuilder	subType(String subType)
PlatformUserBuilder	tenantId(String tenant)
PlatformUserBuilder	theme(String theme)
PlatformUserBuilder	type(String type)	Set the type of the user.
PlatformUserBuilder	userDefinitionId(String userDefinitionId)
PlatformUserBuilder	userDefinitionKey(String userDefinitionKey)

Method Detail

tenantId

PlatformUserBuilder tenantId(String tenant)

userDefinitionId

PlatformUserBuilder userDefinitionId(String userDefinitionId)

userDefinitionKey

PlatformUserBuilder userDefinitionKey(String userDefinitionKey)

type

PlatformUserBuilder type(String type)

Set the type of the user.

Parameters:

type - that the user should have

See Also:

for known types

subType

PlatformUserBuilder subType(String subType)

presence

PlatformUserBuilder presence(String presence)

Setting the presence is only possible for new users. Updating a user presence should happen over PlatformIdentityService.updateUserPresence(String, String, String)

Parameters:

presence - that the user should have

See Also:

for known states

state

PlatformUserBuilder state(String state)

subState

PlatformUserBuilder subState(String subState)

firstName

PlatformUserBuilder firstName(String firstName)

lastName

PlatformUserBuilder lastName(String lastName)

displayName

PlatformUserBuilder displayName(String displayName)

avatarId

PlatformUserBuilder avatarId(String avatarId)

email

PlatformUserBuilder email(String email)

password

PlatformUserBuilder password(String password)

language

PlatformUserBuilder language(String language)

theme

PlatformUserBuilder theme(String theme)

setInfo

PlatformUserBuilder setInfo(String name,
                            Object value)

save

PlatformUser save()

Performs the save of the user

Returns:

the saved PlatformUser