com.ibm.commerce.messaging.commands
Class ReleaseShipNotifyCmdImpl

java.lang.Object
  CacheableCommandImpl
      com.ibm.commerce.command.AbstractECTargetableCommand
          com.ibm.commerce.command.TaskCommandImpl
              com.ibm.commerce.messaging.commands.ReleaseShipNotifyCmdImpl
All Implemented Interfaces:
ECCommand, ECTargetableCommand, ReleaseShipNotifyCmd, TaskCommand

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
static java.lang.String COPYRIGHT
The IBM copyright notice field.
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext
Fields inherited from interface com.ibm.commerce.messaging.commands.ReleaseShipNotifyCmd
defaultCommandClassName, NAME
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
Constructor Summary
ReleaseShipNotifyCmdImpl()
ReleaseShipNotifyCmdImpl constructor.
Method Summary
java.lang.Object[] getMessageSubjectParms()
Returns the parameters used for notification message subject.
java.lang.Integer getMessageType()
Returns the Message Type Id.
java.lang.Integer getOrderReleaseNum()
Returns the order release number.
java.lang.Long getOrderRn()
Returns the order reference number.
java.util.Vector getRecipients()
Returns the list of recipients for the notification message.
void performExecute()
This is the real function part of the ReleaseShipNotify command - sends a notification message.
void sendNotification(Messaging anMs)
Sends the notification message to the shopper.
void sendNotification(Messaging anMs, java.util.Enumeration anenRecipients)
Sends the notification message to all the recipients set by the caller of the task command.
void setMessageSubjectParms(java.lang.Object[] newMessageSubjectParms)
Sets the parameters for notification message subject.
void setOrderReleaseNum(java.lang.Integer anOrderReleaseNum)
Sets the order release number.
void setOrderRn(java.lang.Long anOrderRn)
Sets the order reference number.
void setRecipients(java.util.Vector newRecipients)
Sets the list of recipients for the notification message.
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, validateParameters
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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()
ReleaseShipNotifyCmdImpl constructor.
Method Detail

getMessageSubjectParms

public java.lang.Object[] getMessageSubjectParms()
Returns the parameters used for notification message subject.
Returns:
parameters list in object array

getMessageType

public java.lang.Integer getMessageType()
                                 throws java.rmi.RemoteException,
                                        CreateException,
                                        javax.naming.NamingException,
                                        FinderException
Returns the Message Type Id.
Returns:
the message type id
Throws:
java.rmi.RemoteException
CreateException
javax.naming.NamingException
FinderException

getOrderReleaseNum

public java.lang.Integer getOrderReleaseNum()
Returns the order release number.
Returns:
the order release number

getOrderRn

public java.lang.Long getOrderRn()
Returns the order reference number.
Returns:
java.lang.Long

getRecipients

public java.util.Vector getRecipients()
Returns the list of recipients for the notification message.
Returns:
java.util.Vector

performExecute

public void performExecute()
                    throws ECException
This is the real function part of the ReleaseShipNotify command - sends a notification message.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - Raised with ERR_REMOTE_EXCEPTION message when it encounters a RemoteException. Raised with ERR_CREATE_EXCEPTION message when it encounters a CreateException. Raised with ERR_GENERIC message when it encounters a NamingException. Raised with ERR_FINDER_EXCEPTION message when it encounters a FinderException.

sendNotification

public void sendNotification(Messaging anMs)
                      throws ECSystemException,
                             javax.naming.NamingException,
                             FinderException,
                             CreateException,
                             java.rmi.RemoteException
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.
Throws:
ECSystemException
javax.naming.NamingException
FinderException
CreateException
java.rmi.RemoteException

sendNotification

public void sendNotification(Messaging anMs,
                             java.util.Enumeration anenRecipients)
                      throws ECSystemException
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 the Enumeration object.
Throws:
ECSystemException

setMessageSubjectParms

public void setMessageSubjectParms(java.lang.Object[] newMessageSubjectParms)
Sets the parameters for notification message subject.
Specified by:
setMessageSubjectParms in interface ReleaseShipNotifyCmd
Parameters:
newMessageSubjectParms - the parameters list (an Object array) used by the subject

setOrderReleaseNum

public void setOrderReleaseNum(java.lang.Integer anOrderReleaseNum)
Sets the order release number.
Specified by:
setOrderReleaseNum in interface ReleaseShipNotifyCmd
Parameters:
anOrderReleaseNum - the release number of the order

setOrderRn

public void setOrderRn(java.lang.Long anOrderRn)
Sets the order reference number.
Specified by:
setOrderRn in interface ReleaseShipNotifyCmd
Parameters:
anOrderRn - the order number

setRecipients

public void setRecipients(java.util.Vector newRecipients)
Sets the list of recipients for the notification message.
Specified by:
setRecipients in interface ReleaseShipNotifyCmd
Parameters:
newRecipients - the vector of recipients

Feedback