com.ibm.commerce.tools.optools.returns.commands
Interface CSRReturnCancelCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
- All Known Implementing Classes:
- CSRReturnCancelCmdImpl
- public interface CSRReturnCancelCmd
- extends ToolsControllerCommand
Brief Description:
Cancels a return by setting the state of the return to cancelled.
This command is a wrapper for the ReturnCancelCmd command.
See the command class com.ibm.commerce.returns.commands.ReturnCancelCmd for more detailed information
on the behavior.
Input parameters:
1) XML - An xml input stream representing a list of return items to add to a return.
The following is a sample value for the XML parameter.
<?xml version="1.0" encoding "UTF-8">
<XML>
<returnId>1001</returnId>
<customerId>1234</customerId>
</XML>
The mandatory data in the xml stream are the following:
- returnId
- customerId
2) URL - The URL to redirect to if the command completes successfully.
Output parameters:
None.
Exceptions:
ECApplicationException - if ReturnCancelCmd throws an exception
Commands called:
1) ReturnCancelCmd
Special behavior:
None.
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
public static final java.lang.String NAME
- Interface name