org.kuali.rice.kew.api.rule

Class RoleName.Builder

java.lang.Object

org.kuali.rice.kew.api.rule.RoleName.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, RoleNameContract

Enclosing class:

RoleName

public static final class RoleName.Builder
extends Object
implements Serializable, ModelBuilder, RoleNameContract

A builder which can be used to construct RoleName instances. Enforces the constraints of the RoleNameContract.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
RoleName	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static RoleName.Builder	create(RoleNameContract contract)
static RoleName.Builder	create(String name, String baseName, String label)
static RoleName.Builder	createWithClassName(String attributeClassName, String baseName, String label)
String	getBaseName() This is the base name value for the Role on an attribute.
String	getLabel() A label for the Role on an attribute.
String	getName() This is the composite name value for the Role on an attribute.
String	getReturnUrl() This is the return URL for the given Role for a role attribute
void	setBaseName(String baseName)
void	setLabel(String label)
void	setName(String name)
void	setReturnUrl(String returnUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createWithClassName

public static RoleName.Builder createWithClassName(String attributeClassName,
                                   String baseName,
                                   String label)

create

public static RoleName.Builder create(String name,
                      String baseName,
                      String label)

create

public static RoleName.Builder create(RoleNameContract contract)

build

public RoleName build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

getName

public String getName()

Description copied from interface: RoleNameContract

This is the composite name value for the Role on an attribute. It consists of of the roleAttribute's class name + '!' + roleBaseName

Specified by:

getName in interface RoleNameContract

Returns:

name

getBaseName

public String getBaseName()

Description copied from interface: RoleNameContract

This is the base name value for the Role on an attribute. It consists of of the name of the Role

Specified by:

getBaseName in interface RoleNameContract

Returns:

baseName

getReturnUrl

public String getReturnUrl()

Description copied from interface: RoleNameContract

This is the return URL for the given Role for a role attribute

Specified by:

getReturnUrl in interface RoleNameContract

Returns:

returnUrl

getLabel

public String getLabel()

Description copied from interface: RoleNameContract

A label for the Role on an attribute.

Specified by:

getLabel in interface RoleNameContract

Returns:

label

setName

public void setName(String name)

setBaseName

public void setBaseName(String baseName)

setReturnUrl

public void setReturnUrl(String returnUrl)

setLabel

public void setLabel(String label)