com.ibm.commerce.tools.optools.order.commands
Interface CSROrderCancelCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, ToolsControllerCommand
All Known Implementing Classes:
CSROrderCancelCmdImpl

public interface CSROrderCancelCmd
extends ToolsControllerCommand

Cancels the order. This command can also add comment to the order and send the comment to the specified email address.

Behavior

Parameters

XML
An input xml_string that contains all the required data to cancel orders.
 Example xml_string:
  <?xml version="1.0" encoding "UTF-8">
    <selectedOrders>12345</selectedOrders>
    <newComment>The User has requested to cancel the orders.</newComment>
    <sendEmail>false</sendEmail>
    <email>jane@ibm.com</email>
    <notifyMerchant>0</notifyMerchant>
    <notifyShopper>0</notifyShopper>
  </xml>
URL
The URL to be called when the command completes successfully.

Exception Conditions

Throws all exceptions that thrown by AdminOrderCancelCmd and CSROrderCommentsNotifyCmd.

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
          The name of this command.
 
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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name.
See Also:
Constant Field Values