com.ibm.commerce.tools.optools.returns.commands
Interface CSRReturnPrepareCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
- All Known Implementing Classes:
- CSRReturnPrepareCmdImpl
- public interface CSRReturnPrepareCmd
- extends ToolsControllerCommand
Brief Description:
Prepares the return specified by <returnId>.
This command is a wrapper for the ReturnPrepareCmd command.
See the command class com.ibm.commerce.returns.commands.ReturnPrepareCmd 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>
<refundComment>comment</refundPolicyId>
</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.
Commands called:
1) ReturnPrepareCmd
Special behavior:
1) When the ReturnItemAddCmd command is called the forUserId paremeter is set in the request
properties to the value in the <customerId> xml tag.
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