com.ibm.commerce.user.beans

Class RoleDataBean

java.lang.Object

com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

com.ibm.commerce.user.objects.RoleAccessBean

com.ibm.commerce.user.beansrc.RoleDataBeanBase

com.ibm.commerce.user.beans.RoleDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, Delegator, com.ibm.commerce.user.beans.RoleInputDataBean, com.ibm.commerce.user.beans.RoleSmartDataBean, java.io.Serializable

public class RoleDataBean
extends com.ibm.commerce.user.beansrc.RoleDataBeanBase
implements com.ibm.commerce.user.beans.RoleInputDataBean, com.ibm.commerce.user.beans.RoleSmartDataBean

This bean is used to display the WebSphere Commerce defined roles.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The class name.
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
RoleDataBean()

Method Summary

Modifier and Type	Method and Description
static java.lang.Integer[]	getAllRoles() Gets the list of role IDs for all the roles defined in the ROLE table.
CommandContext	getCommandContext() Gets the command context set within this bean.
java.lang.String	getDataBeanKeyRoleId() Gets the key(role id) of this data bean.
java.lang.String	getDescription() Retrieves the display name of the role
java.lang.String	getDisplayName() Retrieves the display name of the role
TypedProperty	getRequestProperties() Gets the request property set within this bean.
void	populate() Retrieves data from the database.
void	setCommandContext(CommandContext aCommandContext) Sets the command context within this bean.
void	setDataBeanKeyRoleId(java.lang.String aRoleId) Sets the key(role id) of this data bean.
void	setRequestProperties(TypedProperty aRequestProperty) Sets the request property within this bean.

Methods inherited from class com.ibm.commerce.user.beansrc.RoleDataBeanBase

getDelegate

Methods inherited from class com.ibm.commerce.user.objects.RoleAccessBean

findByName, findByNameNoCache, getEntity, getName, getRoleId, getRoleIdInEntityType, instantiateEntity, setDescription, setInitKey_roleId, setInitKey_roleId, setName, setRoleId, setRoleId

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

The class name.

Constructor Detail

RoleDataBean

public RoleDataBean()

Method Detail

getRequestProperties

public TypedProperty getRequestProperties()

Gets the request property set within this bean.

Specified by:

getRequestProperties in interface InputDataBean

Returns:

com.ibm.commerce.datatype.TypedProperty

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperty)

Sets the request property within this bean.

Specified by:

setRequestProperties in interface InputDataBean

Parameters:

aRequestProperty - com.ibm.commerce.datatype.TypedProperty

getDataBeanKeyRoleId

public java.lang.String getDataBeanKeyRoleId()

Gets the key(role id) of this data bean.

Specified by:

getDataBeanKeyRoleId in interface com.ibm.commerce.user.beans.RoleSmartDataBean

Returns:

The key of this data bean.

getCommandContext

public CommandContext getCommandContext()

Gets the command context set within this bean.

Specified by:

getCommandContext in interface SmartDataBean

Returns:

com.ibm.commerce.command.CommandContext

setCommandContext

public void setCommandContext(CommandContext aCommandContext)

Sets the command context within this bean.

Specified by:

setCommandContext in interface SmartDataBean

Parameters:

aCommandContext - com.ibm.commerce.command.CommandContext

setDataBeanKeyRoleId

public void setDataBeanKeyRoleId(java.lang.String aRoleId)

Sets the key(role id) of this data bean.

Specified by:

setDataBeanKeyRoleId in interface com.ibm.commerce.user.beans.RoleInputDataBean

Parameters:

aRoleId - The key of this data bean.

populate

public void populate()

Retrieves data from the database.

Specified by:

populate in interface SmartDataBean

Throws:

java.lang.Exception

getDisplayName

public java.lang.String getDisplayName()

Retrieves the display name of the role

Returns:

the display name of the role

getDescription

public java.lang.String getDescription()

Retrieves the display name of the role

Overrides:

getDescription in class RoleAccessBean

Returns:

the display name of the role

getAllRoles

public static final java.lang.Integer[] getAllRoles()

Gets the list of role IDs for all the roles defined in the ROLE table.

Returns:

The role IDs defined in the ROLE table.