org.bonitasoft.engine.identity

Class RoleCreator

java.lang.Object

org.bonitasoft.engine.identity.RoleCreator

All Implemented Interfaces:

Serializable

public class RoleCreator
extends Object
implements Serializable

represents a helper for creating a Role. Chaining is possible with this creator to ease the Role creation.
For instance, new RoleCreator("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	RoleCreator.RoleField represents the available Role field

Constructor Summary

Constructors

Constructor and Description
RoleCreator(String name) create a new creator instance with a given role name

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleCreator

public RoleCreator(String name)

create a new creator instance with a given role name

Parameters:

name - The name of the role to create

Method Detail

setDisplayName

public RoleCreator setDisplayName(String displayName)

Parameters:

displayName - The role's display name to create

Returns:

The current RoleCreator

setDescription

public RoleCreator setDescription(String description)

Parameters:

description - The role's description to create

Returns:

The current RoleCreator

setIconName

@Deprecated
public RoleCreator setIconName(String iconName)

Deprecated. since 7.3.0 use #setIcon

Parameters:

iconName - The role's icon name to create

Returns:

The current RoleCreator

setIconPath

@Deprecated
public RoleCreator setIconPath(String iconPath)

Deprecated. since 7.3.0 use #setIcon

Parameters:

iconPath - The role's icon path to create

Returns:

The current RoleCreator

setIcon

public RoleCreator 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<RoleCreator.RoleField,Serializable> getFields()

Returns:

The current role's information to create

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