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

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

public class CSROrderItemAddressUpdateCmdImpl
extends ToolsControllerCommandImpl
implements CSROrderItemAddressUpdateCmd

This is the default implementation of the CSROrderItemAddressUpdateCmd 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.
 java.lang.Integer orgLangId
          The language id.
 
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. CSROrderItemAddressUpdateCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSROrderItemAddressUpdateCmdImpl()
           
 
Method Summary
protected  void createAddress()
          This method calls CSRCustomerAddressAddCmd to create a new address based on the address information passed to the command
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.
protected  void executeOrderItemUpdate()
          Update order item(s) with the given shipping address ID by calling OrderItemUpdateCmd.
 java.lang.String getAddressId()
          Returns the address ID.
 java.lang.String getCustomerId()
          Returns the customer ID.
 java.util.Vector getItems()
          Returns all the orderItems as a Vector.
protected  java.lang.String getMissingParam(java.lang.String msg)
          Deprecated.  
 java.util.Hashtable getNLS()
          Returns the properties containing all translatable messages for this command.
  CommandContext getOrgCmdContext()
          Returns the original commandContext (administrator's command context).
 java.lang.Integer getOrgLangId()
          Returns original language ID.
 java.util.Locale getOrgLocale()
          Returns original locale.
  TypedProperty getOrgReqProperties()
          Returns original request properties.
 java.lang.String getRedirectURL()
          Returns the redirect URL that is to be executed after this controller command terminates.
  AccessVector getResources()
          Gets the access vector accessed by this command.
 void performExecute()
          This method updates the shipping address of the order item for the customer.
protected  void setAddressId(java.lang.String newAddressId)
          Sets address ID.
protected  void setCustomerId(java.lang.String newCustomerId)
          Sets customer ID.
 void setItems(java.util.Vector newItems)
          Sets all orderItems to be updated.
protected  void setNLS(java.util.Hashtable newNLS)
          Sets NLS properties.
protected  void setOrgCmdContext( CommandContext newOrgCmdContext)
          Sets original commandContext.
protected  void setOrgLangId(java.lang.Integer newOrgLangId)
          Sets the 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.
 void validateParameters()
          This method gets the XMLObject from the GUI Dialog.
 
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.

orgLangId

public java.lang.Integer orgLangId
The language id.
Constructor Detail

CSROrderItemAddressUpdateCmdImpl

public CSROrderItemAddressUpdateCmdImpl()
Method Detail

createAddress

protected void createAddress()
                      throws ECException
This method calls CSRCustomerAddressAddCmd to create a new address based on the address information passed to the command

In address Hashtable, it contains following information:

Throws:
ECException - if the address can not be created.

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.

executeOrderItemUpdate

protected void executeOrderItemUpdate()
                               throws ECException
Update order item(s) with the given shipping address ID by calling OrderItemUpdateCmd.
Throws:
ECException - Rethrows all exceptions that are thrown by the OrderItemUpdateCmd.

getAddressId

public java.lang.String getAddressId()
Returns the address ID.
Returns:
The shipping address ID to be used.

getCustomerId

public java.lang.String getCustomerId()
Returns the customer ID.
Returns:
The customer ID that owns the address.

getItems

public java.util.Vector getItems()
Returns all the orderItems as a Vector.
Returns:
A vector containing the order items to update.

getMissingParam

protected java.lang.String getMissingParam(java.lang.String msg)
Deprecated.  
Returns the missing parameter for the address.
Parameters:
msg - The error message.
Returns:
The formatted error message string that will be sent to the error page.

getNLS

public java.util.Hashtable getNLS()
Returns the properties containing all translatable messages for this command.
Returns:
Name value pairs of translatable messages.

getOrgCmdContext

public CommandContext getOrgCmdContext()
Returns the original commandContext (administrator's command context).
Returns:
The original command context when calling this command.

getOrgLangId

public java.lang.Integer getOrgLangId()
Returns original language 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 properties.

getRedirectURL

public java.lang.String getRedirectURL()
Returns the redirect URL that is to be executed after this controller command terminates.
Returns:
The name of the view to be redirected to.

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.

performExecute

public void performExecute()
                    throws ECException
This method updates the shipping address of the order item for the customer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - if shipping address of the order item can not be updated.

setAddressId

protected void setAddressId(java.lang.String newAddressId)
Sets address ID.
Parameters:
newAddressId - The shipping address ID to be used for updating the order item.

setCustomerId

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

setItems

public void setItems(java.util.Vector newItems)
Sets all orderItems to be updated.
Parameters:
newItems - A vector containing the order items to be updated.

setNLS

protected void setNLS(java.util.Hashtable newNLS)
Sets NLS properties.
Parameters:
newNLS - The name-value pairs containing the messages to be used by this command.

setOrgCmdContext

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

setOrgLangId

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

setOrgLocale

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

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 name of the redirect page.

validateParameters

public void validateParameters()
                        throws ECApplicationException
This method gets the XMLObject from the GUI Dialog. It parses the XMLObject to get the information into the commands local variables. It also sets the success redirect URL, customer ID and address ID if any.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECApplicationException - If cannot parse the XMLObject as expected.