public abstract class CSRReturnBaseCmdImpl extends CSRBaseControllerCommandImpl
Modifier and Type | Field and Description |
---|---|
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 |
Constructor and Description |
---|
CSRReturnBaseCmdImpl()
Constructor for CSRReturnBaseCmdImpl.
|
Modifier and Type | Method and Description |
---|---|
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 environment.
|
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
public CSRReturnBaseCmdImpl()
protected TypedProperty exceptionUtil(TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName)
public 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
public java.lang.String getReturnId()
protected abstract void parseInputXMLObject(java.util.Hashtable xmlRoot) throws ECApplicationException
public void setCustomerId(java.lang.String newCustomerId)
protected void setNLS(java.util.Hashtable newNLS)
public void setOrigCmdContext(CommandContext newOrigCmdContext)
public void setOrigReqProperties(TypedProperty newOrigReqProperties)
public void setRedirectURL(java.lang.String newRedirectURL)
public void setReturnId(java.lang.String newReturnId)
public java.lang.String traceFormat(TypedProperty prop)
public void validateParameters() throws ECApplicationException