java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.usermanagement.commands.RoleAddCmdImpl
RoleAdd command creates a role at the site level and assigns it to the Root Organization.
Roles are stored in the ROLE table.
Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so type the command with the HTTPS secure protocol.
The parameter roleName is mandatory.
Behavior
Exception Conditions
Field Summary | |
---|---|
protected
boolean |
bToolsFramework Whether the command is called by the tools framework. |
static java.lang.String |
CLASSNAME The name of this implementation of the command. |
static java.lang.String |
COPYRIGHT IBM Copyright notice field. |
protected
java.lang.String |
istrRoleDescription The role description. |
protected
java.lang.String |
istrRoleDisplayName The role display name. |
protected
java.lang.String |
istrRoleId The role identifier. |
protected
java.lang.String |
istrRoleName The role name. |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.usermanagement.commands. RoleAddCmd |
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
RoleAddCmdImpl() |
Method Summary | |
---|---|
java.lang.String |
getRoleDescription() Returns the role description. |
java.lang.String |
getRoleDisplayName() Returns the istrRoleDisplayName. |
java.lang.String |
getRoleId() Returns the role identifier. |
java.lang.String |
getRoleName() Returns the role name. |
TypedProperty |
getViewInputProperties() Returns the request properties without the tools framework objects. |
void |
performExecute() Creates the new Role. |
void |
reset() Resets the values of the command so it can be reused to add another role. |
void |
setRequestProperties(
TypedProperty reqProperties) Sets the request properties. |
void |
setRoleDescription(java.lang.String astrRoleDescription) Sets the role description. |
void |
setRoleDisplayName(java.lang.String istrRoleDisplayName) Sets the istrRoleDisplayName. |
void |
setRoleName(java.lang.String astrRoleName) Sets the role name. |
void |
validateParameters() Validates that the name of the role is defined and an exist role of the same name does not exist. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
setRetriable,
setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
getForUserId,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
protected boolean bToolsFramework
protected java.lang.String istrRoleId
protected java.lang.String istrRoleName
protected java.lang.String istrRoleDisplayName
protected java.lang.String istrRoleDescription
Constructor Detail |
---|
public RoleAddCmdImpl()
Method Detail |
---|
public java.lang.String getRoleDescription()
getRoleDescription
in interface
RoleAddCmd
public java.lang.String getRoleId()
getRoleId
in interface
RoleAddCmd
public java.lang.String getRoleName()
getRoleName
in interface
RoleAddCmd
public TypedProperty getViewInputProperties()
getViewInputProperties
in interface
ControllerCommand
getViewInputProperties
in class
ControllerCommandImpl
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- If there is a problem creating the new role or executing the PostRoleAdd
command.public void reset()
reset
in interface
RoleAddCmd
reset
in class
AbstractECTargetableCommand
public void setRequestProperties(TypedProperty reqProperties) throws ECException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
reqProperties
- the parameters passed to the command.ECException
- If there is a problem indicated by the PreRoleAdd
command.public void setRoleDescription(java.lang.String astrRoleDescription)
setRoleDescription
in interface
RoleAddCmd
astrRoleDescription
- the role
description.public void setRoleName(java.lang.String astrRoleName)
setRoleName
in interface
RoleAddCmd
astrRoleName
- the role name.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
- If the name is not specified or the name already exists for another
role.public java.lang.String getRoleDisplayName()
public void setRoleDisplayName(java.lang.String istrRoleDisplayName)
istrRoleDisplayName
- The istrRoleDisplayName to
set