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.CSROrderCommentsAddCmdImpl
This is the default implementation of the
CSROrderCommentsAddCmd
command.
This command calls the following command:
This command uses the following AccessBeans:
OrderAccessBean
OrderCommentAccessBean
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
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.optools.order.commands. CSROrderCommentsAddCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
CSROrderCommentsAddCmdImpl() CSROrderCommentsAddCmdImpl constructor. |
Method Summary | |
---|---|
void |
callCSROrderCommentsNotifyCmd(java.lang.Long orderId) Calls CSROrderCommentsNotify command to send comment to a specified email address. |
protected
void |
exceptionUtil(
TypedProperty prop, java.lang.Exception ex, java.lang.String methodName,
java.lang.String cmdName, java.lang.String errMsg) This method sets up the response property when an exception occurs. |
java.lang.String |
getInComment() Returns the order comment. |
java.lang.String |
getIsNotifyShopper() Returns the flag to indicate if there is an need to send the comment to the email address. |
java.util.Hashtable |
getNLS() Returns NLS properties. |
java.lang.Long[] |
getOrderIds() Returns the list of orders IDs which need to be added the order comments. |
CommandContext |
getOrgCmdContext() Returns original command context. |
AccessVector |
getResources() Gets the access vector accessed by this command. |
java.lang.String |
getXmlfile() Return the XML file. |
void |
performExecute() This method performs the execution to add comment to orders. |
void |
setInComment(java.lang.String newInComment) Set order comment. |
void |
setIsNotifyShopper(java.lang.String notifyShopper) Set the flag to indicate if the order comment needs to be emailed. |
protected
void |
setNLS(java.util.Hashtable newNLS) Set NLS properties. |
void |
setOrderIds(java.lang.Long[] newOrderIds) Set Order IDs which needs to be canceled. |
protected
void |
setOrgCmdContext(
CommandContext newOrgCmdContext) Set original command context. |
void |
setReceiverEmailAddress(java.lang.String newReceiverEmailAddr) Set the email address. |
protected
void |
setXMLFile(java.lang.String newXMLFile) Sets XML file. |
void |
validateParameters() Sets the NLS properties and parse the input XML parameters. |
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,
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,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
setRequestProperties,
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,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public CSROrderCommentsAddCmdImpl()
Method Detail |
---|
public void callCSROrderCommentsNotifyCmd(java.lang.Long orderId) throws ECException
orderId
- The order ID.
ECException
- if the comment can not be sent.protected void exceptionUtil(TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName, java.lang.String errMsg) throws ECApplicationException
prop
- The response typed property.ex
- The catched exception.methodName
- The name of the method with exception.cmdName
- The name of the command.errMsg
- The translated error message string.
ECApplicationException
- The exception to be sent to the error
handling view.public java.lang.String getInComment()
public java.lang.String getIsNotifyShopper()
public java.util.Hashtable getNLS()
public java.lang.Long[] getOrderIds()
public CommandContext getOrgCmdContext()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
- If the resource can not be
retrieved.public java.lang.String getXmlfile()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- if comment can not be sent.public void setInComment(java.lang.String newInComment)
newInComment
- The order comment.public void setIsNotifyShopper(java.lang.String notifyShopper)
notifyShopper
- The flag to indicate if the order comment
needs to be emailed.protected void setNLS(java.util.Hashtable newNLS)
newNLS
- The NLS properties.public void setOrderIds(java.lang.Long[] newOrderIds)
newOrderIds
- The order IDs.protected void setOrgCmdContext(CommandContext newOrgCmdContext)
newOrgCmdContext
- The original command
context.public void setReceiverEmailAddress(java.lang.String newReceiverEmailAddr)
newReceiverEmailAddr
- The email address.protected void setXMLFile(java.lang.String newXMLFile)
newXMLFile
- The XML file.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
- if parameter is invalid.