com.ibm.commerce.usermanagement.commands
Class RoleAddCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.usermanagement.commands.RoleAddCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, RoleAddCmd

public class RoleAddCmdImpl
extends ControllerCommandImpl
implements RoleAddCmd

The implementation for the AddressDelete command which deletes an entry from the member's address book.


Field Summary
protected  boolean bToolsFramework
           
static java.lang.String CLASSNAME
           
static java.lang.String COPYRIGHT
           
protected  java.lang.String istrRoleDescription
           
protected  java.lang.String istrRoleId
           
protected  java.lang.String istrRoleName
           
 
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()
          Get the description of the role.
 java.lang.String getRoleId()
          Get the roleId of the role added.
 java.lang.String getRoleName()
          Get the name of the role.
 TypedProperty getViewInputProperties()
          Retrieves the request properties set by the setRequestProperties() method that will be passed onto the view command.
 void performExecute()
          Contains the actual business logic of the command It should be implemented by all the command writer.
 void reset()
          Reset all instance variables of the command to initial state so it can be used again.
 void setRequestProperties(TypedProperty reqProperties)
          The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
 void setRoleDescription(java.lang.String astrRoleDescription)
          Set the description of the role
 void setRoleName(java.lang.String astrRoleName)
          Set the name of the role.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

bToolsFramework

protected boolean bToolsFramework

CLASSNAME

public static final java.lang.String CLASSNAME

COPYRIGHT

public static final java.lang.String COPYRIGHT

istrRoleDescription

protected java.lang.String istrRoleDescription

istrRoleId

protected java.lang.String istrRoleId

istrRoleName

protected java.lang.String istrRoleName
Constructor Detail

RoleAddCmdImpl

public RoleAddCmdImpl()
Method Detail

getRoleDescription

public java.lang.String getRoleDescription()
Description copied from interface: RoleAddCmd
Get the description of the role.
Specified by:
getRoleDescription in interface RoleAddCmd
Following copied from interface: com.ibm.commerce.usermanagement.commands.RoleAddCmd
Returns:
The description of the role

getRoleId

public java.lang.String getRoleId()
Description copied from interface: RoleAddCmd
Get the roleId of the role added. Called after the command is execute to get the roleId of the rold just added.
Specified by:
getRoleId in interface RoleAddCmd
Following copied from interface: com.ibm.commerce.usermanagement.commands.RoleAddCmd
Returns:
The roleId of the role added

getRoleName

public java.lang.String getRoleName()
Description copied from interface: RoleAddCmd
Get the name of the role.
Specified by:
getRoleName in interface RoleAddCmd
Following copied from interface: com.ibm.commerce.usermanagement.commands.RoleAddCmd
Returns:
The name of the role

getViewInputProperties

public TypedProperty getViewInputProperties()
Description copied from interface: ControllerCommand
Retrieves the request properties set by the setRequestProperties() method that will be passed onto the view command. Command writer can overwrite this method to return all, part or non of the request properties to be passed to the view command
Specified by:
getViewInputProperties in interface ControllerCommand
Overrides:
getViewInputProperties in class ControllerCommandImpl
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Returns:
com.ibm.commerce.datatype.TypeProperty

performExecute

public void performExecute()
                    throws ECException
Description copied from interface: ECCommand
Contains the actual business logic of the command It should be implemented by all the command writer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

reset

public void reset()
Description copied from interface: RoleAddCmd
Reset all instance variables of the command to initial state so it can be used again.
Specified by:
reset in interface RoleAddCmd
Overrides:
reset in class AbstractECTargetableCommand

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException
Description copied from interface: ControllerCommand
The WebController calls this method before invoking the execute method in this command to set the request properties for this command. It is the responsibility of the implementer of the ControllerCommand to extract the required input parameters from the request properties and perform parameter checking.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Parameters:
requestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
com.ibm.commerce.exception.ECException. -  

setRoleDescription

public void setRoleDescription(java.lang.String astrRoleDescription)
Description copied from interface: RoleAddCmd
Set the description of the role
Specified by:
setRoleDescription in interface RoleAddCmd
Following copied from interface: com.ibm.commerce.usermanagement.commands.RoleAddCmd
Parameters:
astrRoleDescription - The description of the role

setRoleName

public void setRoleName(java.lang.String astrRoleName)
Description copied from interface: RoleAddCmd
Set the name of the role.
Specified by:
setRoleName in interface RoleAddCmd
Following copied from interface: com.ibm.commerce.usermanagement.commands.RoleAddCmd
Parameters:
astrRoleName - The name of the role

validateParameters

public void validateParameters()
                        throws ECException
Description copied from interface: ECCommand
Performs server side parameter checking. This method replaces the checkParameters() method in a previous version of the code.

Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -