java.lang.ObjectCacheableCommandImpl
com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.command.ControllerCommandImpl
com.ibm.commerce.tools.command.ToolsControllerCommandImpl
com.ibm.commerce.tools.optools.order.commands.CSROrderCancelCmdImpl
This is the default implementation of the CSROrderCancelCmd command.
This command calls the following command(s):
This command uses the following AccessBean(s):
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 |
Methods inherited from interface com.ibm.commerce.security.Protectable |
fulfills, getOwner |
Field Detail |
public static final java.lang.String COPYRIGHT
public java.lang.String xmlFile
public static final java.lang.String DIALOG_URL
Constructor Detail |
public CSROrderCancelCmdImpl()
Method Detail |
protected void cancelOrders() throws java.lang.Exception
protected void exceptionUtil(TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName, java.lang.String errMsg) throws ECApplicationException
protected void executeCommentNotifyCmd(java.lang.String orderId) throws ECApplicationException, ECException
protected void executeOrderCancelCmd(java.lang.String orderId) throws ECApplicationException, ECException
public java.lang.String getEmailAddress()
public java.lang.String getNewComment()
public java.util.Hashtable getNLS()
public java.util.Vector getOrderIds()
public CommandContext getOrgCmdContext()
public java.lang.String getRedirectURL()
public AccessVector getResources() throws ECException
public java.lang.String getSuccessMsg()
public java.lang.String getXmlFile()
public boolean isEmailError()
public boolean isSendEmail()
public void performExecute() throws ECException
protected void setEmailAddress(java.lang.String newEmailAddress)
protected void setEmailError(boolean newEmailError)
public void setNewComment(java.lang.String newNewComment)
protected void setNLS(java.util.Hashtable newNLS)
public void setOrderIds(java.util.Vector newOrderIds)
protected void setOrgCmdContext(CommandContext newOrgCmdContext)
public void setRedirectURL(java.lang.String newRedirectURL)
protected void setSendEmail(boolean newSendEmail)
protected void setSuccessMsg(java.lang.String newSuccessMsg)
public void setXmlFile(java.lang.String newXmlFile)
public void validateParameters() throws ECException
public java.lang.String getNotifyMerchant()
public void setNotifyMerchant(java.lang.String notifyMerchant)
public java.lang.String getNotifyShopper()
public void setNotifyShopper(java.lang.String notifyShopper)
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.