com.ibm.commerce.tools.optools.order.commands
Interface CSROrderCancelCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
- All Known Implementing Classes:
- CSROrderCancelCmdImpl
- public interface CSROrderCancelCmd
- extends ToolsControllerCommand
Call the AdminOrderCancel command to cancel orders. This command can also add commets to the canceled order and
send the comment to the email address specified.
URL calling syntax:
Https://host_name/path/CSROrderCancel?XML=xml_string&URL=return_url
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>
</xml>
URL
The URL to be called when the command completes successfully
Response Parameters:
None.
Exceptions:
It throws all the exceptions that the AdminOrderCancel command will throw.
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.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
defaultCommandClassName
public static final java.lang.String defaultCommandClassName
- The default implementation class name.
NAME
public static final java.lang.String NAME