org.kuali.rice.kew.api.rule

Class RoleName

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

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

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, RoleNameContract

public final class RoleName
extends AbstractDataTransferObject
implements RoleNameContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoleName.Builder A builder which can be used to construct RoleName instances.

Constructor Summary

Constructors

Constructor and Description
RoleName(String attributeClassName, String baseName, String label)

Method Summary

Modifier and Type	Method and Description
static String	constructRoleValue(String attributeClassName, String roleName)
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

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleName

public RoleName(String attributeClassName,
                String baseName,
                String label)

Method Detail

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

constructRoleValue

public static String constructRoleValue(String attributeClassName,
                                        String roleName)