org.bonitasoft.engine.identity

Class RoleUpdater

java.lang.Object

org.bonitasoft.engine.identity.RoleUpdater

All Implemented Interfaces:

Serializable

public class RoleUpdater
extends Object
implements Serializable

represents a helper for updating a Role. Chaining is possible with this updator to ease the Role update.
For instance, new RoleUpdater("member").setDisplayName("Member").setIconName("userIcon");

Since:

6.0.0

Author:

Matthieu Chaffotte, Celine Souchet

See Also:

Role, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoleUpdater.RoleField represent the available Role fields

Constructor Summary

Constructors

Constructor and Description
RoleUpdater() Default Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<RoleUpdater.RoleField,Serializable>	getFields()
int	hashCode()
RoleUpdater	setDescription(String description)
RoleUpdater	setDisplayName(String displayName)
RoleUpdater	setIcon(String filename, byte[] content) set the icon on the role to be created
RoleUpdater	setIconName(String iconName) Deprecated. since 7.3.0 use #setIcon
RoleUpdater	setIconPath(String iconPath) Deprecated. since 7.3.0 use #setIcon
RoleUpdater	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleUpdater

public RoleUpdater()

Default Constructor.

Method Detail

setName

public RoleUpdater setName(String name)

Parameters:

name - The role's new name to update

Returns:

The current RoleUpdater for chaining purpose

setDisplayName

public RoleUpdater setDisplayName(String displayName)

Parameters:

displayName - The role's display name to update

Returns:

The current RoleUpdater for chaining purpose

setDescription

public RoleUpdater setDescription(String description)

Parameters:

description - The role's description to update

Returns:

The current RoleUpdater for chaining purpose

setIconName

@Deprecated
public RoleUpdater setIconName(String iconName)

Deprecated. since 7.3.0 use #setIcon

Parameters:

iconName - The role's icon name to update

Returns:

The current RoleUpdater for chaining purpose

setIconPath

@Deprecated
public RoleUpdater setIconPath(String iconPath)

Deprecated. since 7.3.0 use #setIcon

Parameters:

iconPath - The role's icon path to update

Returns:

The current RoleUpdater for chaining purpose

setIcon

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

set the icon on the role to be created

Parameters:

filename - the filename of the icon

content - the content of the icon

Returns:

the role created

getFields

public Map<RoleUpdater.RoleField,Serializable> getFields()

Returns:

The role's fields to update

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