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

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

public class CSROrderCommentsAddCmdImpl
extends ToolsControllerCommandImpl
implements CSROrderCommentsAddCmd

This is the default implementation of the CSROrderCommentsAddCmd command.

This command calls the following command:

This command uses the following AccessBeans:

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.optools.order.commands. CSROrderCommentsAddCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSROrderCommentsAddCmdImpl()
          CSROrderCommentsAddCmdImpl constructor.
 
Method Summary
 void callCSROrderCommentsNotifyCmd(java.lang.Long orderId)
          Calls CSROrderCommentsNotify command to send comment to a specified email address.
protected  void exceptionUtil( TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName, java.lang.String errMsg)
          This method sets up the response property when an exception occurs.
 java.lang.String getInComment()
          Returns the order comment.
 java.lang.String getIsNotifyShopper()
          Returns the flag to indicate if there is an need to send the comment to the email address.
 java.util.Hashtable getNLS()
          Returns NLS properties.
 java.lang.Long[] getOrderIds()
          Returns the list of orders IDs which need to be added the order comments.
  CommandContext getOrgCmdContext()
          Returns original command context.
  AccessVector getResources()
          Gets the access vector accessed by this command.
 java.lang.String getXmlfile()
          Return the XML file.
 void performExecute()
          This method performs the execution to add comment to orders.
 void setInComment(java.lang.String newInComment)
          Set order comment.
 void setIsNotifyShopper(java.lang.String notifyShopper)
          Set the flag to indicate if the order comment needs to be emailed.
protected  void setNLS(java.util.Hashtable newNLS)
          Set NLS properties.
 void setOrderIds(java.lang.Long[] newOrderIds)
          Set Order IDs which needs to be canceled.
protected  void setOrgCmdContext( CommandContext newOrgCmdContext)
          Set original command context.
 void setReceiverEmailAddress(java.lang.String newReceiverEmailAddr)
          Set the email address.
protected  void setXMLFile(java.lang.String newXMLFile)
          Sets XML file.
 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
Constructor Detail

CSROrderCommentsAddCmdImpl

public CSROrderCommentsAddCmdImpl()
CSROrderCommentsAddCmdImpl constructor.
Method Detail

callCSROrderCommentsNotifyCmd

public void callCSROrderCommentsNotifyCmd(java.lang.Long orderId)
                                   throws ECException
Calls CSROrderCommentsNotify command to send comment to a specified email address.
Parameters:
orderId - The order ID.
Throws:
ECException - if the comment can not be sent.

exceptionUtil

protected void exceptionUtil(TypedProperty prop,
                             java.lang.Exception ex,
                             java.lang.String methodName,
                             java.lang.String cmdName,
                             java.lang.String errMsg)
                      throws ECApplicationException
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.
errMsg - The translated error message string.
Throws:
ECApplicationException - The exception to be sent to the error handling view.

getInComment

public java.lang.String getInComment()
Returns the order comment.
Returns:
The order comment.

getIsNotifyShopper

public java.lang.String getIsNotifyShopper()
Returns the flag to indicate if there is an need to send the comment to the email address.
Returns:
"true" if there is a need to send the comment.

getNLS

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

getOrderIds

public java.lang.Long[] getOrderIds()
Returns the list of orders IDs which need to be added the order comments.
Returns:
The order IDs.

getOrgCmdContext

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

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:
A vector of resource action pairs
Throws:
ECException - If the resource can not be retrieved.

getXmlfile

public java.lang.String getXmlfile()
Return the XML file.
Returns:
The entire XML file.

performExecute

public void performExecute()
                    throws ECException
This method performs the execution to add comment to orders. If the flag to indicate sending email is set, it will also send the order comment to the email address specified.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - if comment can not be sent.

setInComment

public void setInComment(java.lang.String newInComment)
Set order comment.
Parameters:
newInComment - The order comment.

setIsNotifyShopper

public void setIsNotifyShopper(java.lang.String notifyShopper)
Set the flag to indicate if the order comment needs to be emailed.
Parameters:
notifyShopper - The flag to indicate if the order comment needs to be emailed.

setNLS

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

setOrderIds

public void setOrderIds(java.lang.Long[] newOrderIds)
Set Order IDs which needs to be canceled.
Parameters:
newOrderIds - The order IDs.

setOrgCmdContext

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

setReceiverEmailAddress

public void setReceiverEmailAddress(java.lang.String newReceiverEmailAddr)
Set the email address.
Parameters:
newReceiverEmailAddr - The email address.

setXMLFile

protected void setXMLFile(java.lang.String newXMLFile)
Sets XML file.
Parameters:
newXMLFile - The XML file.

validateParameters

public void validateParameters()
                        throws ECException
Sets the NLS properties and parse the input XML parameters.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException - if parameter is invalid.