com.ibm.commerce.tools.optools.order.commands
Class CSREmailOrderCmdImpl

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.CSREmailOrderCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, CSREmailOrderCmd, ECCommand, ECTargetableCommand, ToolsControllerCommand

public class CSREmailOrderCmdImpl
extends ToolsControllerCommandImpl
implements CSREmailOrderCmd

This is the default implementation of the CSROEmailOrderCmd command.

This command calls the following Command:

This command uses the following AccessBeans:

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The copyright statement.
 
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. CSREmailOrderCmd
NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
CSREmailOrderCmdImpl()
           
 
Method Summary
protected  void exceptionUtil( TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName, java.lang.String errMsg)
          Common exception code for this command.
 java.lang.String getBCC()
          Gets the BCC recipients.
 java.lang.String getCC()
          Gets the CC recipients.
 java.lang.String getMessageType()
          Gets the message type name.
 java.util.Hashtable getNLS()
          Gets the NLS messages hashtable.
 java.lang.String getOrderId()
          Gets the order reference number.
 java.lang.String getRecipients()
          Gets the recipients.
 java.lang.String getRedirectURL()
          Gets the redirect url.
 java.lang.String getSender()
          Gets the sender of the email.
 java.lang.String getSubject()
          Gets the subject of the email.
 java.lang.String getXmlFile()
          Gets the xmlFile to return to when the command has completed.
 void performExecute()
          Business logic of the command to send the message type using the messaging subsystem.
 void setBCC(java.lang.String newBCC)
          Sets the BCC recipients of the message.
 void setCC(java.lang.String newCC)
          Sets the CC recipients of the message.
 void setMessageType(java.lang.String newMessageType)
          Sets the message type name.
 void setNLS(java.util.Hashtable newNLS)
          Sets the NLS hashtable.
 void setOrderId(java.lang.String newOrderId)
          Sets the order reference number.
 void setRecipients(java.lang.String newRecipients)
          Sets the recipients of the message.
 void setRedirectURL(java.lang.String newURL)
          Sets the redirect url.
 void setSender(java.lang.String newSender)
          Sets the sender of the message.
 void setSubject(java.lang.String newSubject)
          Sets the subject of the message.
 void setXmlFile(java.lang.String newXmlFile)
          Sets XML file.
 void validateParameters()
          This method gets XMLObject from the GUI Dialog and get ready to parse it.
 
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, getResources, 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, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
The copyright statement.
See Also:
Constant Field Values
Constructor Detail

CSREmailOrderCmdImpl

public CSREmailOrderCmdImpl()
Method Detail

exceptionUtil

protected void exceptionUtil(TypedProperty prop,
                             java.lang.Exception ex,
                             java.lang.String methodName,
                             java.lang.String cmdName,
                             java.lang.String errMsg)
                      throws ECApplicationException
Common exception code for this command.
Parameters:
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.
Throws:
ECApplicationException - The exception to be sent to the error handling view.

getBCC

public java.lang.String getBCC()
Gets the BCC recipients.
Returns:
The BCC recipients

getCC

public java.lang.String getCC()
Gets the CC recipients.
Returns:
The CC recipients.

getMessageType

public java.lang.String getMessageType()
Gets the message type name.
Returns:
The message type name.

getNLS

public java.util.Hashtable getNLS()
Gets the NLS messages hashtable.
Returns:
The messages hashtable.

getOrderId

public java.lang.String getOrderId()
Gets the order reference number.
Returns:
The order reference number.

getRecipients

public java.lang.String getRecipients()
Gets the recipients.
Returns:
The recipients.

getRedirectURL

public java.lang.String getRedirectURL()
Gets the redirect url.
Returns:
The redirect url.

getSender

public java.lang.String getSender()
Gets the sender of the email.
Returns:
The sender.

getSubject

public java.lang.String getSubject()
Gets the subject of the email.
Returns:
The subject.

getXmlFile

public java.lang.String getXmlFile()
Gets the xmlFile to return to when the command has completed.
Returns:
The xmlFile of the tool widget.

performExecute

public void performExecute()
                    throws ECException
Business logic of the command to send the message type using the messaging subsystem.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - if the OrderReceived message can not be composed or sent.

setBCC

public void setBCC(java.lang.String newBCC)
Sets the BCC recipients of the message.
Parameters:
newBCC - The string of BCC recipients email addresses.

setCC

public void setCC(java.lang.String newCC)
Sets the CC recipients of the message.
Parameters:
newCC - The string of CC recipients email addresses.

setMessageType

public void setMessageType(java.lang.String newMessageType)
Sets the message type name.
Parameters:
newMessageType - The message type name.

setNLS

public void setNLS(java.util.Hashtable newNLS)
Sets the NLS hashtable.
Parameters:
newNLS - The hashtable with NLS messages

setOrderId

public void setOrderId(java.lang.String newOrderId)
Sets the order reference number.
Parameters:
newOrderId - The order reference number.

setRecipients

public void setRecipients(java.lang.String newRecipients)
Sets the recipients of the message.
Parameters:
newRecipients - The string of recipients email addresses.

setRedirectURL

public void setRedirectURL(java.lang.String newURL)
Sets the redirect url.
Parameters:
newURL - The redirect url.

setSender

public void setSender(java.lang.String newSender)
Sets the sender of the message.
Parameters:
newSender - The sender used.

setSubject

public void setSubject(java.lang.String newSubject)
Sets the subject of the message.
Parameters:
newSubject - The subject used.

setXmlFile

public void setXmlFile(java.lang.String newXmlFile)
Sets XML file.

validateParameters

public void validateParameters()
                        throws ECException
This method gets XMLObject from the GUI Dialog and get ready to parse it.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException - If cannot parse the XMLObject, it throws ECApplicationException.