com.ibm.commerce.tools.optools.order.commands
Class CSRBaseControllerCommandImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl
                          |
                          +--com.ibm.commerce.tools.optools.order.commands.CSRBaseControllerCommandImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ToolsControllerCommand
Direct Known Subclasses:
CSROrderItemDeleteCmdImpl, CSROrderPrepareCmdImpl, CSROrderProcessCmdImpl, CSRReturnBaseCmdImpl

public class CSRBaseControllerCommandImpl
extends ToolsControllerCommandImpl

Base class for CSR Order Capture controller commands. This class contains common helper functions for all sub-classes to execute any pre-controller commands specified in EC_XMLObject NVP of the input request properties.

The pre-commands are referenced as XML.preCmdChain.preCommand element in EC_XMLObject which

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
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.tools.command. ToolsControllerCommand
NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
CSRBaseControllerCommandImpl()
          The constructor for CSRBaseControllerCommandImpl.
 
Method Summary
protected  void callPreCommands( TypedProperty property, CommandContext tempCmdContext)
          Execute each pre command one by one if the pre commands are specified.
protected  java.lang.String findCmdInterfaceName(java.lang.Integer storeId, java.lang.String cmdURLName)
          Returns the command interface name for the given store ID and command URL name.
 boolean getIfExePreCmdChains()
          Returns if there is a list of pre commands need to be executed.
 java.util.Vector getPreCmdChain()
          Gets the list of pre commands.
 void setIfExePreCmdChains(boolean newIfExePreCmdChains)
          Sets the flag to indicate if there is a list of pre commands need to be executed.
 void setPreCmdChain(java.util.Vector newPreCmdChain)
          Sets the list of pre commands.
 void validateParameters()
          Validates the input parameters of the command.
 
Methods inherited from class com.ibm.commerce.tools.command. ToolsControllerCommandImpl
getViewInputProperties, setRequestProperties
 
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, performExecute, reset, 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, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values
Constructor Detail

CSRBaseControllerCommandImpl

public CSRBaseControllerCommandImpl()
The constructor for CSRBaseControllerCommandImpl.
Method Detail

callPreCommands

protected void callPreCommands(TypedProperty property,
CommandContext tempCmdContext)
                        throws ECException
Execute each pre command one by one if the pre commands are specified.
Parameters:
property - The request properties.
tempCmdContext - The command context.
Throws:
ECException - Rethrows all pre commands exceptions

findCmdInterfaceName

protected java.lang.String findCmdInterfaceName(java.lang.Integer storeId,
                                                java.lang.String cmdURLName)
                                         throws ECException,
                                                javax.ejb.FinderException
Returns the command interface name for the given store ID and command URL name.
Parameters:
storeId - The ID of the store.
cmdURLName - The command URL name.
Returns:
the name of the interface.
Throws:
ECException
FinderException

getIfExePreCmdChains

public boolean getIfExePreCmdChains()
Returns if there is a list of pre commands need to be executed.
Returns:
true if there is a list of pre commands need to be executed; false if there is not.

getPreCmdChain

public java.util.Vector getPreCmdChain()
Gets the list of pre commands.
Returns:
the list of pre commands.

setIfExePreCmdChains

public void setIfExePreCmdChains(boolean newIfExePreCmdChains)
Sets the flag to indicate if there is a list of pre commands need to be executed.
Parameters:
newIfExePreCmdChains - The flag to indicate if there is a list of pre commands need to be executed.

setPreCmdChain

public void setPreCmdChain(java.util.Vector newPreCmdChain)
Sets the list of pre commands.
Parameters:
newPreCmdChain - The list of pre commands.

validateParameters

public void validateParameters()
                        throws ECApplicationException
Validates the input parameters of the command.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECApplicationException