org.bonitasoft.engine.identity

Class UserCreator

java.lang.Object

org.bonitasoft.engine.identity.UserCreator

All Implemented Interfaces:

Serializable

public class UserCreator
extends Object
implements Serializable

represents a helper for creating User. Chaining is possible with this creator to ease the User creation.
For instance, new UserCreator("john.doe", "password").setFirstname("John").setLastname("Doe");

Since:

6.0.0

Author:

Matthieu Chaffotte

See Also:

User, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserCreator.UserField represents the available User field

Constructor Summary

Constructors

Constructor and Description
UserCreator(String name, String password) create a new creator instance with a given user name and password

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<UserCreator.UserField,Serializable>	getFields()
Map<ContactDataCreator.ContactDataField,Serializable>	getPersoFields()
Map<ContactDataCreator.ContactDataField,Serializable>	getProFields()
int	hashCode()
UserCreator	setEnabled(boolean enabled)
UserCreator	setFirstName(String firstName)
UserCreator	setIcon(String filename, byte[] content)
UserCreator	setIconName(String iconName) Deprecated. since 7.3.0 use #setIcon
UserCreator	setIconPath(String iconPath) Deprecated. since 7.3.0 use #setIcon
UserCreator	setJobTitle(String jobTitle)
UserCreator	setLastName(String lastName)
UserCreator	setManagerUserId(long managerUserId)
UserCreator	setPersonalContactData(ContactDataCreator creator)
UserCreator	setProfessionalContactData(ContactDataCreator creator)
UserCreator	setTitle(String title)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserCreator

public UserCreator(String name,
                   String password)

create a new creator instance with a given user name and password

Parameters:

name - the name of the user to create

password - the password of the user to create

Method Detail

setFirstName

public UserCreator setFirstName(String firstName)

Parameters:

firstName - the user's firstname to create

Returns:

the current UserCreator

setLastName

public UserCreator setLastName(String lastName)

Parameters:

lastName - the user's lastName to create

Returns:

the current UserCreator

setIconName

@Deprecated
public UserCreator setIconName(String iconName)

Deprecated. since 7.3.0 use #setIcon

Parameters:

iconName - the user's icon name to create

Returns:

the current UserCreator

setIconPath

@Deprecated
public UserCreator setIconPath(String iconPath)

Deprecated. since 7.3.0 use #setIcon

Parameters:

iconPath - the user's icon path to create

Returns:

the current UserCreator

setTitle

public UserCreator setTitle(String title)

Parameters:

title - the user's title to create

Returns:

the current UserCreator

setJobTitle

public UserCreator setJobTitle(String jobTitle)

Parameters:

jobTitle - the user's jobTitle to create

Returns:

the current UserCreator

setManagerUserId

public UserCreator setManagerUserId(long managerUserId)

Parameters:

managerUserId - the user's manager id to create

Returns:

the current UserCreator

setEnabled

public UserCreator setEnabled(boolean enabled)

Parameters:

enabled - enabled Boolean set to true if the user is enabled inside the organization

Returns:

the current UserCreator

getFields

public Map<UserCreator.UserField,Serializable> getFields()

Returns:

the current user information to create

getPersoFields

public Map<ContactDataCreator.ContactDataField,Serializable> getPersoFields()

Returns:

the current user personal information to create

getProFields

public Map<ContactDataCreator.ContactDataField,Serializable> getProFields()

Returns:

the current user professional information to create

setPersonalContactData

public UserCreator setPersonalContactData(ContactDataCreator creator)

Parameters:

creator - the user's personal contact information to create

Returns:

the current UserCreator

setProfessionalContactData

public UserCreator setProfessionalContactData(ContactDataCreator creator)

Parameters:

creator - the user's professional contact information to create

Returns:

the current UserCreator

setIcon

public UserCreator setIcon(String filename,
                           byte[] content)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object