CSROrderCancelCmdImpl

java.lang.Object
- com.ibm.websphere.command.TargetableCommandImpl
- - com.ibm.websphere.command.CacheableCommandImpl
  - - com.ibm.commerce.command.MeasuredCacheableCommandImpl
    - - 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, ECCommand, ECTargetableCommand, Protectable, ToolsControllerCommand, CSROrderCancelCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class CSROrderCancelCmdImpl
extends ToolsControllerCommandImpl
implements CSROrderCancelCmd
```
This is the default implementation of the CSROrderCancelCmd command.
This command calls the following command(s):
- AdminOrderCancelCmd
- CSROrderCommentsNotifyCmd
This command uses the following AccessBean(s):
- OrderAccessBean
- OrderCommentAccessBean
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`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.websphere.command.TargetableCommandImpl
LOCAL

Fields inherited from interface com.ibm.commerce.tools.optools.order.commands.CSROrderCancelCmd
defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command
serialVersionUID

Constructor Summary

Constructors
Constructor and Description

CSROrderCancelCmdImpl()

Constructors
Constructor and Description
`CSROrderCancelCmdImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`isForcedCancel()` Gets the forcedCancel flag.
`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.
`void`	`setForcedCancel(boolean aForcedCancel)` Sets the forcedCancel flag.
`void`	`setNewComment(java.lang.String newNewComment)` Sets the order comment.
`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.
`void`	`setRedirectURL(java.lang.String newRedirectURL)` Sets redirect URL.
`void`	`setRequestProperties(TypedProperty viewParm)` The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
`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

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.websphere.command.CacheableCommandImpl
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object
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, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Field Detail
  - COPYRIGHT
```
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
  - 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
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - if order can not be canceled.
  - setNewComment
```
public void setNewComment(java.lang.String newNewComment)
```
    Sets the order comment.
    
    Parameters:
    
    newNewComment - The order comment.
  - setOrderIds
```
public void setOrderIds(java.util.Vector newOrderIds)
```
    Sets Order IDs which needs to be canceled.
    
    Parameters:
    
    newOrderIds - The order IDs.
  - setRedirectURL
```
public void setRedirectURL(java.lang.String newRedirectURL)
```
    Sets redirect URL.
    
    Parameters:
    
    newRedirectURL - The redirect URL.
  - setXmlFile
```
public void setXmlFile(java.lang.String newXmlFile)
```
    Sets XML file.
    
    Parameters:
    
    newXmlFile - The XML file used.
  - 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.
  - isForcedCancel
```
public boolean isForcedCancel()
```
    Gets the forcedCancel flag.
    
    Returns:
    
    forcedCancel boolean value.
  - setForcedCancel
```
public void setForcedCancel(boolean aForcedCancel)
```
    Sets the forcedCancel flag.
    
    Parameters:
    
    aForcedCancel -
  - setRequestProperties
```
public void setRequestProperties(TypedProperty viewParm)
                          throws ECApplicationException
```
    The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ToolsControllerCommandImpl
    
    Parameters:
    
    viewParm - request properties.
    
    Throws:
    
    ECApplicationException

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

Fields inherited from interface com.ibm.commerce.tools.optools.order.commands.CSROrderCancelCmd

Fields inherited from interface com.ibm.websphere.command.Command

Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.AccCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.commerce.security.Protectable

COPYRIGHT

xmlFile

DIALOG_URL

CSROrderCancelCmdImpl

getEmailAddress

getNewComment

getNLS

getOrderIds

getOrgCmdContext

getRedirectURL

getResources

getSuccessMsg

getXmlFile

isEmailError

isSendEmail

performExecute

setNewComment

setOrderIds

setRedirectURL

setXmlFile

validateParameters

getNotifyMerchant

setNotifyMerchant

getNotifyShopper

setNotifyShopper

isForcedCancel

setForcedCancel

setRequestProperties