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

Interface CSROrderCancelCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, 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

• Cancel the order. Merchant and customer will be notified if notifyMerchant and notifyShopper is set to 1.
• Add comment to the order.
• Send comment to the specified email address if sendEmail is true.

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

Fields

Modifier and Type	Field and Description
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.

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

serialVersionUID

Method Summary

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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

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

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class name.

See Also:

Constant Field Values