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

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.CSROrderItemSplitCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, CSROrderItemSplitCmd, ECCommand, ECTargetableCommand, ToolsControllerCommand

public class CSROrderItemSplitCmdImpl
extends ToolsControllerCommandImpl
implements CSROrderItemSplitCmd

This is the default implementation of the CSROrderItemSplitCmd command.

This command calls the following Commands:

This command uses the following AccessBeans:

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String ERRTASK_NAME
          Error handling viewname for this command.
 
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.optools.order.commands. CSROrderItemSplitCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSROrderItemSplitCmdImpl()
           
 
Method Summary
protected  TypedProperty exceptionUtil( TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName)
          This method sets up the response property when an exception occurs.
 void executeCSROrderStatusChange(java.lang.String theOrderId, java.lang.String newStatus)
          Calls CSROrderStatusChangeCmd command to change the status of the order and its order items.
protected  void executeOrderItemSplit()
          This method calls OrderItemMoveCmd command to move the order items from one order to another order.
 java.lang.String getCustomerId()
          Returns customer ID.
 java.lang.String getFromOrderId()
          Returns the ID of the order which the order items are moved from.
 java.lang.String getNewOrderId()
          Returns the ID of the newly created order.
 java.util.Hashtable getNLS()
          Returns NLS properties.
 java.util.Vector getOrderItems()
          Returns a vector of order items to be moved.
  CommandContext getOrgCmdContext()
          Returns original command context.
 java.lang.Integer getOrgLangId()
          Returns original langauge ID.
 java.util.Locale getOrgLocale()
          Returns original locale.
  TypedProperty getOrgReqProperties()
          Returns original request properties.
 java.lang.String getRedirectURL()
          Returns redirect URL.
  AccessVector getResources()
          Gets the access vector accessed by this command.
 java.lang.String getToOrderId()
          Returns ID of the order which the order items will be moved to.
 void performExecute()
          This method perform the execution of moving the order items from one order to another order.
protected  void setCustomerId(java.lang.String newCustomerId)
          Sets customer Id.
protected  void setFromOrderId(java.lang.String newFromOrderId)
          Sets the order ID of the order items which will be moved from.
protected  void setNewOrderId(java.lang.String newNewOrderId)
          Sets the order ID of the newly created order.
protected  void setNLS(java.util.Hashtable newNLS)
          Sets NLS properties.
protected  void setOrderItems(java.util.Vector newOrderItems)
          Sets order items which needs to be moved.
protected  void setOrgCmdContext( CommandContext newOrgCmdContext)
          Sets original command context.
protected  void setOrgLangId(java.lang.Integer newOrgLangId)
          Sets original language ID.
protected  void setOrgLocale(java.util.Locale newOrgLocale)
          Sets original locale.
protected  void setOrgReqProperties( TypedProperty newOrgReqProperties)
          Sets original request properties.
protected  void setRedirectURL(java.lang.String newRedirectURL)
          Sets redirect URL.
protected  void setToOrderId(java.lang.String newToOrderId)
          Sets order ID of the order items which will be moved to.
 void validateParameters()
          Sets the NLS properties and parse the input XML parameters.
 
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, getStoreId, getUser, getUserId, isReadyToCallExecute, 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, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

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

ERRTASK_NAME

public static java.lang.String ERRTASK_NAME
Error handling viewname for this command.
Constructor Detail

CSROrderItemSplitCmdImpl

public CSROrderItemSplitCmdImpl()
Method Detail

exceptionUtil

protected TypedProperty exceptionUtil(TypedProperty prop,
                                      java.lang.Exception ex,
                                      java.lang.String methodName,
                                      java.lang.String cmdName)
This method sets up the response property when an exception occurs.
Parameters:
prop - The response typed property.
ex - The catched exception.
methodName - The name of the method with exception.
cmdName - The name of the command.
Returns:
The proper typed property with redirection to the error page.

executeCSROrderStatusChange

public void executeCSROrderStatusChange(java.lang.String theOrderId,
                                        java.lang.String newStatus)
                                 throws ECException
Calls CSROrderStatusChangeCmd command to change the status of the order and its order items.
Parameters:
newStatus - The status of the order and its order items.
theOrderId - The ID of the order.
Throws:
ECException - if unable to change status of the order and its items.

executeOrderItemSplit

protected void executeOrderItemSplit()
                              throws java.lang.Exception
This method calls OrderItemMoveCmd command to move the order items from one order to another order.

If a new order is created, this command will change the status of the new order and its order items to 'E' state.

Throws:
java.lang.Exception - if unable to move order items.

getCustomerId

public java.lang.String getCustomerId()
Returns customer ID.
Returns:
The customer ID.

getFromOrderId

public java.lang.String getFromOrderId()
Returns the ID of the order which the order items are moved from.
Returns:
The ID of the order which the order items are moved from.

getNewOrderId

public java.lang.String getNewOrderId()
Returns the ID of the newly created order.
Returns:
The ID of the newly created order.

getNLS

public java.util.Hashtable getNLS()
Returns NLS properties.
Returns:
The NLS properties.

getOrderItems

public java.util.Vector getOrderItems()
Returns a vector of order items to be moved.
Returns:
The order items to be moved.

getOrgCmdContext

public CommandContext getOrgCmdContext()
Returns original command context.
Returns:
The command context.

getOrgLangId

public java.lang.Integer getOrgLangId()
Returns original langauge ID.
Returns:
The original language ID.

getOrgLocale

public java.util.Locale getOrgLocale()
Returns original locale.
Returns:
The original locale.

getOrgReqProperties

public TypedProperty getOrgReqProperties()
Returns original request properties.
Returns:
The original request propeties.

getRedirectURL

public java.lang.String getRedirectURL()
Returns redirect URL.
Returns:
The redirect URL.

getResources

public AccessVector getResources()
                          throws ECException
Gets the access vector accessed by this command. The default implementation returns null indicating that no protectable resource is accessed by this command.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class AbstractECTargetableCommand
Returns:
The vector of resource action pairs
Throws:
ECException - If the resource can not be retrieved.

getToOrderId

public java.lang.String getToOrderId()
Returns ID of the order which the order items will be moved to.
Returns:
The ID of the order which the order items will be moved to.

performExecute

public void performExecute()
                    throws ECException
This method perform the execution of moving the order items from one order to another order.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - if unable to move items from one order to the other.

setCustomerId

protected void setCustomerId(java.lang.String newCustomerId)
Sets customer Id.
Parameters:
newCustomerId - The customer ID.

setFromOrderId

protected void setFromOrderId(java.lang.String newFromOrderId)
Sets the order ID of the order items which will be moved from.
Parameters:
newFromOrderId - The order ID.

setNewOrderId

protected void setNewOrderId(java.lang.String newNewOrderId)
Sets the order ID of the newly created order.
Parameters:
newNewOrderId - The ID of the newly created order.

setNLS

protected void setNLS(java.util.Hashtable newNLS)
Sets NLS properties.
Parameters:
newNLS - The NLS properties.

setOrderItems

protected void setOrderItems(java.util.Vector newOrderItems)
Sets order items which needs to be moved.
Parameters:
newOrderItems - The order items which needs to be moved.

setOrgCmdContext

protected void setOrgCmdContext(CommandContext newOrgCmdContext)
Sets original command context.
Parameters:
newOrgCmdContext - The original command context.

setOrgLangId

protected void setOrgLangId(java.lang.Integer newOrgLangId)
Sets original language ID.
Parameters:
newOrgLangId - The original language ID.

setOrgLocale

protected void setOrgLocale(java.util.Locale newOrgLocale)
Sets original locale.
Parameters:
newOrgLocale - The original locale.

setOrgReqProperties

protected void setOrgReqProperties(TypedProperty newOrgReqProperties)
Sets original request properties.
Parameters:
newOrgReqProperties - The original request properties.

setRedirectURL

protected void setRedirectURL(java.lang.String newRedirectURL)
Sets redirect URL.
Parameters:
newRedirectURL - The redirect URL.

setToOrderId

protected void setToOrderId(java.lang.String newToOrderId)
Sets order ID of the order items which will be moved to.
Parameters:
newToOrderId - The order ID of the order items which will be moved to.

validateParameters

public void validateParameters()
                        throws ECApplicationException
Sets the NLS properties and parse the input XML parameters. This method also initializes following parameters:
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECApplicationException - If it not contain the required parameters.