java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl | +--com.ibm.commerce.tools.optools.order.commands.CSRBaseControllerCommandImpl | +--com.ibm.commerce.tools.optools.returns.commands.CSRReturnBaseCmdImpl
Base class for all the CSR Returns commands.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
protected
java.lang.String |
customerId |
static java.lang.String |
ERRTASK_NAME Default redirect URL when errors are encountered. |
protected
CommandContext |
origCmdContext |
protected
TypedProperty |
origReqProperties |
protected
java.lang.String |
redirectURL |
protected
java.lang.String |
returnId |
protected
java.util.Hashtable |
returnResBun |
protected
java.util.Hashtable |
xmlRoot |
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.tools.command. ToolsControllerCommand |
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
CSRReturnBaseCmdImpl() Constructor for CSRReturnBaseCmdImpl. |
Method Summary | |
---|---|
protected
TypedProperty |
exceptionUtil(
TypedProperty prop, java.lang.Exception ex, java.lang.String methodName,
java.lang.String cmdName) Utility for performing common tasks prior to throwing exception. |
java.lang.String |
getCustomerId() Gets customer identifier which is used to set the forUserId parameter in the request property when calling a command. |
java.util.Hashtable |
getNLS() Gets reference to property file used for Returns user interface. |
CommandContext |
getOrigCmdContext() Gets command context as it was at the start of command run. |
TypedProperty |
getOrigReqProperties() Gets request property as it was at the start of command run. |
java.lang.String |
getRedirectURL() Gets redirect url. |
AccessVector |
getResources() Gets the access vector used by command. |
java.lang.String |
getReturnId() Gets the unique identifier of the Return being processed. |
protected
abstract void |
parseInputXMLObject(java.util.Hashtable xmlRoot) Parses and retrieves the command's input parameters. |
void |
setCustomerId(java.lang.String newCustomerId) Sets the unique identifier of the customer whom owns the Return being processed. |
protected
void |
setNLS(java.util.Hashtable newNLS) Sets the reference to the contents of the property file. |
void |
setOrigCmdContext(
CommandContext newOrigCmdContext) Saves a copy of the command context at the start of command run. |
void |
setOrigReqProperties(
TypedProperty newOrigReqProperties) Saves a copy of the request properties at the start of command run. |
void |
setRedirectURL(java.lang.String newRedirectURL) Sets the redirect URL. |
void |
setReturnId(java.lang.String newReturnId) Sets unique identifier of the Return being processed. |
java.lang.String |
traceFormat(
TypedProperty prop) Formats a trace message. |
void |
validateParameters() Prepares command enviroment. |
Methods inherited from class com.ibm.commerce.tools.optools.order.commands. CSRBaseControllerCommandImpl |
callPreCommands,
findCmdInterfaceName,
getIfExePreCmdChains,
getPreCmdChain,
setIfExePreCmdChains,
setPreCmdChain |
Methods inherited from class com.ibm.commerce.tools.command. ToolsControllerCommandImpl |
getViewInputProperties,
setRequestProperties |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
performExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
setRetriable,
setViewInputProperties |
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,
getStoreId,
getUser,
getUserId,
performExecute,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected CommandContext origCmdContext
protected TypedProperty origReqProperties
protected java.lang.String returnId
protected java.lang.String customerId
protected java.lang.String redirectURL
protected java.util.Hashtable xmlRoot
protected java.util.Hashtable returnResBun
public static final java.lang.String ERRTASK_NAME
Constructor Detail |
---|
public CSRReturnBaseCmdImpl()
Method Detail |
---|
protected TypedProperty exceptionUtil(TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName)
prop
- existing typed properties object to which to add
propertiesex
- exception about to be thrownmethodName
- name of method in which exception occurredcmdName
- name of command in which exception
occurredpublic java.lang.String getCustomerId()
public java.util.Hashtable getNLS()
public CommandContext getOrigCmdContext()
public TypedProperty getOrigReqProperties()
public java.lang.String getRedirectURL()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
AccessVector
public java.lang.String getReturnId()
protected abstract void parseInputXMLObject(java.util.Hashtable xmlRoot) throws ECApplicationException
xmlRoot
- xml stream represented in a java hashtable
ECApplicationException
public void setCustomerId(java.lang.String newCustomerId)
newCustomerId
- customer identifierprotected void setNLS(java.util.Hashtable newNLS)
newNLS
- national language messages to usepublic void setOrigCmdContext(CommandContext newOrigCmdContext)
newOrigCmdContext
- command contextpublic void setOrigReqProperties(TypedProperty newOrigReqProperties)
newOrigReqProperties
- request propertiespublic void setRedirectURL(java.lang.String newRedirectURL)
newRedirectURL
- URL to which to redirect when command
terminatespublic void setReturnId(java.lang.String newReturnId)
newReturnId
- Return identifierpublic java.lang.String traceFormat(TypedProperty prop)
prop
- message to be formattedpublic void validateParameters() throws ECApplicationException
validateParameters
in interface
ECCommand
validateParameters
in class
CSRBaseControllerCommandImpl
ECApplicationException