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

Methods

Modifier and Type	Method and Description
Map<RoleCreator.RoleField,Serializable>	getFields()
RoleCreator	setDescription(String description)
RoleCreator	setDisplayName(String displayName)
RoleCreator	setIconName(String iconName)
RoleCreator	setIconPath(String iconPath)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

public RoleCreator setIconName(String iconName)

Parameters:

iconName - The role's icon name to create

Returns:

The current RoleCreator

setIconPath

public RoleCreator setIconPath(String iconPath)

Parameters:

iconPath - The role's icon path to create

Returns:

The current RoleCreator

getFields

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

Returns:

The current role's information to create