com.ibm.commerce.tools.optools.returns.commands

Interface CSRReturnPrepareCmd

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:

CSRReturnPrepareCmdImpl

public interface CSRReturnPrepareCmd
extends ToolsControllerCommand

Wrapper for the ReturnPrepareCmd command.

Parameters:

XML

String, in XML format, which contains all the required data. Both returnId and customerId are required.
Example xml_string:

<?xml version="1.0" encoding "UTF-8">
       <XML>
         <returnId>1001</returnId>
         <customerId>1234</customerId>
         <refundComment>comment</refundComment>
       </XML> 

URL

URL to be called when the command completes successfully.

Output parameters:
None.

Exceptions:
ECApplicationException - if ReturnCancelCmd throws an exception

Special behavior:
When the ReturnItemAddCmd command is called the forUserId parameter is set in the request properties to the value in the <customerId> XML tags.

See Also:

ReturnPrepareCmd

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName Default implementation class.
static java.lang.String	NAME Interface name

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

Interface name

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

Default implementation class.

See Also:

Constant Field Values