|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl | +--com.ibm.commerce.tools.optools.order.commands.CSROrderCancelCmdImpl
Call the AdminOrderCancel command to cancel orders. This class will also add commets to the canceled order. If the method isSendEmail() returns true, this command will also call CSROrderCommentsNotify command to send the comment to the email address specified.
Field Summary | |
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
DIALOG_URL
|
protected java.lang.String |
xmlFile
|
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()
Cancel orders and add comment to orders if comment exists. |
protected void |
exceptionUtil(TypedProperty prop,
java.lang.Exception ex,
java.lang.String methodName,
java.lang.String cmdName,
java.lang.String errMsg)
Common exception code for this command. |
protected void |
executeCommentNotifyCmd(java.lang.String orderId)
Call the CSROrderCommentsNotofy to Send the order comment. |
protected void |
executeOrderCancelCmd(java.lang.String orderId)
Call the AdminOrderCancel command to cancel an order. |
java.lang.String |
getEmailAddress()
Get the email address. |
java.lang.String |
getNewComment()
Get the comment needed to add to the order(s). |
java.util.Hashtable |
getNLS()
Return NLS properties. |
java.util.Vector |
getOrderIds()
Return list of order IDs. |
CommandContext |
getOrgCmdContext()
Return original command context. |
java.lang.String |
getRedirectURL()
Return the redirect URL. |
AccessVector |
getResources()
Gets the access vector accessed by this command. |
java.lang.String |
getSuccessMsg()
Return the successful message. |
java.lang.String |
getXmlFile()
Return the XML file. |
boolean |
isEmailError()
Return if it is unable to send the email. |
boolean |
isSendEmail()
Return 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 canceled orders. |
protected void |
setEmailAddress(java.lang.String newEmailAddress)
Set the email address. |
protected void |
setEmailError(boolean newEmailError)
Set the flag to indicate if there is any problem sending email. |
void |
setNewComment(java.lang.String newNewComment)
Set the order comment. |
protected void |
setNLS(java.util.Hashtable newNLS)
Set NLS properties. |
void |
setOrderIds(java.util.Vector newOrderIds)
Set Order IDs which needs to be canceled. |
protected void |
setOrgCmdContext(CommandContext newOrgCmdContext)
Set original command context. |
void |
setRedirectURL(java.lang.String newRedirectURL)
Set redirect URL. |
protected void |
setSendEmail(boolean newSendEmail)
Set the flag to indicate if the order comment needs to be emailed. |
protected void |
setSuccessMsg(java.lang.String newSuccessMsg)
Set the success message. |
void |
setXmlFile(java.lang.String newXmlFile)
Set XML file. |
void |
validateParameters()
Set 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 |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
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, setAccCheck, setForUserId, setOwner |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.security.Protectable |
fulfills, getOwner |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final java.lang.String DIALOG_URL
protected java.lang.String xmlFile
Constructor Detail |
public CSROrderCancelCmdImpl()
Method Detail |
protected void cancelOrders() throws java.lang.Exception
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
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.ECApplicationException
- The exception to be sent to the
error handling view.protected void executeCommentNotifyCmd(java.lang.String orderId) throws ECApplicationException, ECException
orderId
- The order ID to send the order comment.ECApplicationException
- ECException
- protected void executeOrderCancelCmd(java.lang.String orderId) throws ECApplicationException, ECException
orderId
- The order ID.ECApplicationException
- The exception descriptionECException
- 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
getResources
in interface ECCommand
getResources
in class AbstractECTargetableCommand
public java.lang.String getSuccessMsg()
public java.lang.String getXmlFile()
public boolean isEmailError()
public boolean isSendEmail()
public void performExecute() throws ECException
performExecute
in interface ECCommand
performExecute
in class AbstractECTargetableCommand
ECException
- protected void setEmailAddress(java.lang.String newEmailAddress)
newEmailAddress
- The email address.protected void setEmailError(boolean newEmailError)
newEmailError
- The flag to indicate if email has not been successfully sent.public void setNewComment(java.lang.String newNewComment)
newNewComment
- The order comment.protected void setNLS(java.util.Hashtable newNLS)
newNLS
- The NLS properties.public void setOrderIds(java.util.Vector newOrderIds)
newNewComment
- The order IDs.protected void setOrgCmdContext(CommandContext newOrgCmdContext)
newOrgCmdContext
- The original command context.public void setRedirectURL(java.lang.String newRedirectURL)
newRedirectURL
- The redirect URL.protected void setSendEmail(boolean newSendEmail)
newSendEmail
- The flag to indicate if the order comment needs to be emailed.protected void setSuccessMsg(java.lang.String newSuccessMsg)
newSuccessMsg
- The success message.public void setXmlFile(java.lang.String newXmlFile)
newXMLFile
- The XML file used.public void validateParameters() throws ECException
validateParameters
in interface ECCommand
validateParameters
in class AbstractECTargetableCommand
ECException
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |