com.ibm.commerce.messaging.commands
Class ReleaseShipNotifyCmdImpl
- java.lang.Object
-
- com.ibm.websphere.command.TargetableCommandImpl
-
- com.ibm.websphere.command.CacheableCommandImpl
-
- com.ibm.commerce.command.MeasuredCacheableCommandImpl
-
- com.ibm.commerce.command.AbstractECTargetableCommand
-
- com.ibm.commerce.command.TaskCommandImpl
-
- com.ibm.commerce.messaging.commands.ReleaseShipNotifyCmdImpl
-
- All Implemented Interfaces:
- com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, ReleaseShipNotifyCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
public class ReleaseShipNotifyCmdImpl extends TaskCommandImpl implements ReleaseShipNotifyCmd
Sends an E-mail notification message for order release shipment. To switch to this implementation, corresponding rows with interface name that this class implements in CMDREG table must be updated with this class name.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
COPYRIGHT
The IBM copyright notice field.-
Fields inherited from interface com.ibm.commerce.messaging.commands.ReleaseShipNotifyCmd
defaultCommandClassName, NAME
-
-
Constructor Summary
Constructors Constructor and Description ReleaseShipNotifyCmdImpl()
The ReleaseShipNotifyCmdImpl constructor calls its parents constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method and Description java.lang.Object[]
getMessageSubjectParms()
This method returns the parameters used for the notification message subject.java.lang.Integer
getMessageType()
Deprecated.This method is replaced bygetMessageTypeName()
.java.lang.String
getMessageTypeName()
This method returns the message type name.java.lang.Integer
getOrderReleaseNum()
This method returns the order release number.java.lang.Long
getOrderRn()
This method returns the order reference number.java.util.Vector
getRecipients()
This method returns the list of recipients' addresses for the notification message.void
performExecute()
This is the core of the ReleaseShipNotify command.void
sendNotification(Messaging anMs)
This method sends the notification message to the shopper.void
sendNotification(Messaging anMs, java.util.Enumeration anenRecipients)
This method sends the notification message to all the recipients set by the caller of the task command.void
setMessageSubjectParms(java.lang.Object[] newMessageSubjectParams)
This method sets the parameters for notification message subject.void
setOrderReleaseNum(java.lang.Integer anOrderReleaseNum)
This method sets the order release number used in this command.void
setOrderRn(java.lang.Long anOrderRn)
This method sets the order reference number used in this command.void
setRecipients(java.util.Vector newRecipients)
This method sets the list of recipients' addresses for the notification message.-
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
-
Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache
-
Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl
getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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, setCommandTarget, setCommandTargetName, setOutputProperties
-
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
-
-
-
-
Field Detail
-
COPYRIGHT
public static final java.lang.String COPYRIGHT
The IBM copyright notice field.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ReleaseShipNotifyCmdImpl
public ReleaseShipNotifyCmdImpl()
The ReleaseShipNotifyCmdImpl constructor calls its parents constructor.
-
-
Method Detail
-
getMessageSubjectParms
public java.lang.Object[] getMessageSubjectParms()
This method returns the parameters used for the notification message subject.- Returns:
- parameters list in object array
-
getMessageType
public java.lang.Integer getMessageType()
Deprecated. This method is replaced bygetMessageTypeName()
.This method returns the message type ID.- Returns:
- the message type ID
- Throws:
RemoteException
CreateException
NamingException
FinderException
-
getMessageTypeName
public java.lang.String getMessageTypeName()
This method returns the message type name.- Returns:
- the message type name
-
getOrderReleaseNum
public java.lang.Integer getOrderReleaseNum()
This method returns the order release number.- Returns:
- the order release number
-
getOrderRn
public java.lang.Long getOrderRn()
This method returns the order reference number.- Returns:
- java.lang.Long the order reference number
-
getRecipients
public java.util.Vector getRecipients()
This method returns the list of recipients' addresses for the notification message.- Returns:
- java.util.Vector the list of recipients' addresses
-
performExecute
public void performExecute() throws ECException
This is the core of the ReleaseShipNotify command. This method sends the notification message.- Specified by:
performExecute
in interfaceECCommand
- Specified by:
performExecute
in interfacecom.ibm.websphere.command.TargetableCommand
- Overrides:
performExecute
in classAbstractECTargetableCommand
- Throws:
ECException
- Raised withERR_REMOTE_EXCEPTION
message when it encounters a RemoteException. Raised withERR_CREATE_EXCEPTION
message when it encounters aCreateException
. Raised withERR_GENERIC
message when it encounters aNamingException
. Raised withERR_FINDER_EXCEPTION
message when it encounters aFinderException
.
-
sendNotification
public void sendNotification(Messaging anMs) throws ECSystemException
This method sends the notification message to the shopper. If the notification ID of the order is not null, the notification ID will be used. Otherwise, the member ID of the order will be used.- Parameters:
anMs
- theMessaging
object used in this command- Throws:
ECSystemException
-
sendNotification
public void sendNotification(Messaging anMs, java.util.Enumeration anenRecipients) throws ECSystemException
This method sends the notification message to all the recipients set by the caller of the task command. One message will be created for each recipient address stored in theEnumeration
object.- Parameters:
anMs
- theMessaging
object.anenRecipients
- TheEnumeration
object containing one or more addresses.- Throws:
ECSystemException
-
setMessageSubjectParms
public void setMessageSubjectParms(java.lang.Object[] newMessageSubjectParams)
This method sets the parameters for notification message subject.- Specified by:
setMessageSubjectParms
in interfaceReleaseShipNotifyCmd
- Parameters:
newMessageSubjectParams
- the list of parameters used for the subject
-
setOrderReleaseNum
public void setOrderReleaseNum(java.lang.Integer anOrderReleaseNum)
This method sets the order release number used in this command.- Specified by:
setOrderReleaseNum
in interfaceReleaseShipNotifyCmd
- Parameters:
anOrderReleaseNum
- the order release number
-
setOrderRn
public void setOrderRn(java.lang.Long anOrderRn)
This method sets the order reference number used in this command.- Specified by:
setOrderRn
in interfaceReleaseShipNotifyCmd
- Parameters:
anOrderRn
- the order reference number
-
setRecipients
public void setRecipients(java.util.Vector newRecipients)
This method sets the list of recipients' addresses for the notification message.- Specified by:
setRecipients
in interfaceReleaseShipNotifyCmd
- Parameters:
newRecipients
- the vector containing the list of recipients' addresses
-
-