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

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

public class CSROrderCancelCmdImpl
extends ToolsControllerCommandImpl
implements CSROrderCancelCmd

This is the default implementation of the CSROrderCancelCmd command.

This command calls the following command(s):

This command uses the following AccessBean(s):

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String DIALOG_URL
          The return url of a dialog widget.
 java.lang.String xmlFile
          The xmlFile of the framework widget.
 
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. CSROrderCancelCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSROrderCancelCmdImpl()
           
 
Method Summary
protected  void cancelOrders()
          This method will cancel the order, add comment and send it to the 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.
protected  void executeCommentNotifyCmd(java.lang.String orderId)
          Calls the CSROrderCommentsNotifyCmd to send the order comment.
protected  void executeOrderCancelCmd(java.lang.String orderId)
          Call the AdminOrderCancel command to cancel an order.
 java.lang.String getEmailAddress()
          Gets the email address.
 java.lang.String getNewComment()
          Gets the comment needed to add to the order.
 java.util.Hashtable getNLS()
          Returns NLS properties.
 java.lang.String getNotifyMerchant()
          Gets the notifyMerchant value to be used in AdminOrderCancelCmd.
 java.lang.String getNotifyShopper()
          Gets the notifyShopper value to be used in AdminOrderCancelCmd.
 java.util.Vector getOrderIds()
          Returns list of order IDs.
  CommandContext getOrgCmdContext()
          Returns original command context.
 java.lang.String getRedirectURL()
          Returns the redirect URL.
  AccessVector getResources()
          Gets the access vector accessed by this command.
 java.lang.String getSuccessMsg()
          Returns the successful message.
 java.lang.String getXmlFile()
          Returns the XML file.
 boolean isEmailError()
          Returns if it is unable to send the email.
 boolean isSendEmail()
          Returns if there is a need to send the comment to the email address.
 void performExecute()
          This method performs the execution to cancel orders and add comment to the canceled orders.
protected  void setEmailAddress(java.lang.String newEmailAddress)
          Sets the email address.
protected  void setEmailError(boolean newEmailError)
          Sets the flag to indicate if there is any problem sending email.
 void setNewComment(java.lang.String newNewComment)
          Sets the order comment.
protected  void setNLS(java.util.Hashtable newNLS)
          Sets NLS properties.
 void setNotifyMerchant(java.lang.String notifyMerchant)
          Sets the notifyMerchant value.
 void setNotifyShopper(java.lang.String notifyShopper)
          Sets the notifyShopper value.
 void setOrderIds(java.util.Vector newOrderIds)
          Sets Order IDs which needs to be canceled.
protected  void setOrgCmdContext( CommandContext newOrgCmdContext)
          Sets original command context.
 void setRedirectURL(java.lang.String newRedirectURL)
          Sets redirect URL.
protected  void setSendEmail(boolean newSendEmail)
          Sets the flag to indicate if the order comment needs to be emailed.
protected  void setSuccessMsg(java.lang.String newSuccessMsg)
          Sets the success message.
 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

xmlFile

public java.lang.String xmlFile
The xmlFile of the framework widget.

DIALOG_URL

public static final java.lang.String DIALOG_URL
The return url of a dialog widget.
See Also:
Constant Field Values
Constructor Detail

CSROrderCancelCmdImpl

public CSROrderCancelCmdImpl()
Method Detail

cancelOrders

protected void cancelOrders()
                     throws java.lang.Exception
This method will cancel the order, add comment and send it to the specified email address.
Throws:
java.lang.Exception - if the order can not be canceled.

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.

executeCommentNotifyCmd

protected void executeCommentNotifyCmd(java.lang.String orderId)
                                throws ECApplicationException,
ECException
Calls the CSROrderCommentsNotifyCmd to send the order comment.
Parameters:
orderId - The order ID to send the order comment.
Throws:
ECApplicationException - if order comment can not be notified.
ECException - if order comment can nnot be notified.

executeOrderCancelCmd

protected void executeOrderCancelCmd(java.lang.String orderId)
                              throws ECApplicationException,
ECException
Call the AdminOrderCancel command to cancel an order.
Parameters:
orderId - The order ID.
Throws:
ECApplicationException - if order can not be canceled.
ECException - if order can not be canceled.

getEmailAddress

public java.lang.String getEmailAddress()
Gets the email address.
Returns:
The email address.

getNewComment

public java.lang.String getNewComment()
Gets the comment needed to add to the order.
Returns:
The order comment.

getNLS

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

getOrderIds

public java.util.Vector getOrderIds()
Returns list of order IDs.
Returns:
The order IDs.

getOrgCmdContext

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

getRedirectURL

public java.lang.String getRedirectURL()
Returns the 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.

getSuccessMsg

public java.lang.String getSuccessMsg()
Returns the successful message.
Returns:
The successful message.

getXmlFile

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

isEmailError

public boolean isEmailError()
Returns if it is unable to send the email.
Returns:
True if the email has not been sent successfully.

isSendEmail

public boolean isSendEmail()
Returns if there is a need to send the comment to the email address.
Returns:
True if there is a need to send the comment to the email address.

performExecute

public void performExecute()
                    throws ECException
This method performs the execution to cancel orders and add comment to the canceled 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 order can not be canceled.

setEmailAddress

protected void setEmailAddress(java.lang.String newEmailAddress)
Sets the email address.
Parameters:
newEmailAddress - The email address.

setEmailError

protected void setEmailError(boolean newEmailError)
Sets the flag to indicate if there is any problem sending email.
Parameters:
newEmailError - The flag to indicate if email has not been successfully sent.

setNewComment

public void setNewComment(java.lang.String newNewComment)
Sets the order comment.
Parameters:
newNewComment - The order comment.

setNLS

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

setOrderIds

public void setOrderIds(java.util.Vector newOrderIds)
Sets Order IDs which needs to be canceled.

setOrgCmdContext

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

setRedirectURL

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

setSendEmail

protected void setSendEmail(boolean newSendEmail)
Sets the flag to indicate if the order comment needs to be emailed.
Parameters:
newSendEmail - The flag to indicate if the order comment needs to be emailed.

setSuccessMsg

protected void setSuccessMsg(java.lang.String newSuccessMsg)
Sets the success message.
Parameters:
newSuccessMsg - The success message.

setXmlFile

public void setXmlFile(java.lang.String newXmlFile)
Sets 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.

getNotifyMerchant

public java.lang.String getNotifyMerchant()
Gets the notifyMerchant value to be used in AdminOrderCancelCmd.
Returns:
the notifyMerchant value. 1 will notify merchant; 0 will not. Default is 0.

setNotifyMerchant

public void setNotifyMerchant(java.lang.String notifyMerchant)
Sets the notifyMerchant value.
Parameters:
notifyMerchant - The notifyMerchant value.

getNotifyShopper

public java.lang.String getNotifyShopper()
Gets the notifyShopper value to be used in AdminOrderCancelCmd.
Returns:
the notifyShopper value. 1 will notify shopper; 0 will not. Default is 0.

setNotifyShopper

public void setNotifyShopper(java.lang.String notifyShopper)
Sets the notifyShopper value.
Parameters:
notifyShopper - The notifyShopper value.