UserUpdater (Bonita Engine 7.7.3 common API)

java.lang.Object
- org.bonitasoft.engine.identity.UserUpdater

All Implemented Interfaces:

Serializable
```
public class UserUpdater
extends Object
implements Serializable
```
represents a helper for updating a User. Chaining is possible with this updator to ease the User update.
For instance, new UserUpdater.setUsername("john.doe").setFirstname("John").setLastname("Doe");

Since:

6.0.0

Author:

Matthieu Chaffotte, Celine Souchet

See Also:

User, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UserUpdater.UserField
represent the available User fields

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserUpdater.UserField` represent the available `User` fields

Constructor Summary

Constructors
Constructor and Description

UserUpdater()
Default Constructor.

Constructors
Constructor and Description
`UserUpdater()` Default Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Map<UserUpdater.UserField,Serializable>`	`getFields()`
`ContactDataUpdater`	`getPersoContactUpdater()`
`ContactDataUpdater`	`getProContactUpdater()`
`boolean`	`hasFields()` Has this updater at least one field to update (directly or in its personal / professional contact data)?
`int`	`hashCode()`
`UserUpdater`	`setEnabled(boolean enabled)`
`UserUpdater`	`setFirstName(String firstName)`
`UserUpdater`	`setIcon(String filename, byte[] content)`
`UserUpdater`	`setIconName(String iconName)` Deprecated. since 7.3.0 use #setIcon
`UserUpdater`	`setIconPath(String iconPath)` Deprecated. since 7.3.0 use #setIcon
`UserUpdater`	`setJobTitle(String jobTitle)`
`UserUpdater`	`setLastName(String lastName)`
`UserUpdater`	`setManagerId(long managerId)`
`UserUpdater`	`setPassword(String password)`
`UserUpdater`	`setPersonalContactData(ContactDataUpdater persoContactUpdater)`
`UserUpdater`	`setProfessionalContactData(ContactDataUpdater proContactUpdater)`
`UserUpdater`	`setTitle(String title)`
`UserUpdater`	`setUserName(String name)`
`String`	`toString()`

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

- Constructor Detail
  - UserUpdater
```
public UserUpdater()
```
    Default Constructor.
- Method Detail
  - setUserName
```
public UserUpdater setUserName(String name)
```
    Parameters:
    
    name - the user's username to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setPassword
```
public UserUpdater setPassword(String password)
```
    Parameters:
    
    password - the user's password to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setFirstName
```
public UserUpdater setFirstName(String firstName)
```
    Parameters:
    
    firstName - the user's firstname to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setLastName
```
public UserUpdater setLastName(String lastName)
```
    Parameters:
    
    lastName - the user's lastname to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setIconName
```
@Deprecated
public UserUpdater setIconName(String iconName)
```
    Deprecated. since 7.3.0 use #setIcon
    
    Parameters:
    
    iconName - the user's icon name to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setManagerId
```
public UserUpdater setManagerId(long managerId)
```
    Parameters:
    
    managerId - the user's manager id to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setIconPath
```
@Deprecated
public UserUpdater setIconPath(String iconPath)
```
    Deprecated. since 7.3.0 use #setIcon
    
    Parameters:
    
    iconPath - the user's icon path to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setTitle
```
public UserUpdater setTitle(String title)
```
    Parameters:
    
    title - the user's title to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setJobTitle
```
public UserUpdater setJobTitle(String jobTitle)
```
    Parameters:
    
    jobTitle - the user's job title to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setEnabled
```
public UserUpdater setEnabled(boolean enabled)
```
    Parameters:
    
    enabled - allow to know if the current user is enabled inside organization
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - getFields
```
public Map<UserUpdater.UserField,Serializable> getFields()
```
    Returns:
    
    the current user information to udpate
  - setPersonalContactData
```
public UserUpdater setPersonalContactData(ContactDataUpdater persoContactUpdater)
```
    Parameters:
    
    persoContactUpdater - the user's personal contact information to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - setProfessionalContactData
```
public UserUpdater setProfessionalContactData(ContactDataUpdater proContactUpdater)
```
    Parameters:
    
    proContactUpdater - the user's professional contact information to update
    
    Returns:
    
    the current UserUpdater for chaining purpose
  - getPersoContactUpdater
```
public ContactDataUpdater getPersoContactUpdater()
```
    Returns:
    
    the user's personal contact updater object
  - getProContactUpdater
```
public ContactDataUpdater getProContactUpdater()
```
    Returns:
    
    the professional contact updater object
  - hasFields
```
public boolean hasFields()
```
    Has this updater at least one field to update (directly or in its personal / professional contact data)?
    
    Returns:
    
    true if there is at least one field to update
  - setIcon
```
public UserUpdater 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

Class UserUpdater

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserUpdater

Method Detail

setUserName

setPassword

setFirstName

setLastName

setIconName

setManagerId

setIconPath

setTitle

setJobTitle

setEnabled

getFields

setPersonalContactData

setProfessionalContactData

getPersoContactUpdater

getProContactUpdater

hasFields

setIcon

equals

hashCode

toString