Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• EmailIndividualCreateCmdImpl

  public EmailIndividualCreateCmdImpl()
  

Method Detail

• cleanup

  public static void cleanup()
  

  This method cleans up the thread local resources. E-mail activity information is stored in a thread local variable when running under a batch dialog activity.

• getResources

  public AccessVector getResources()
                            throws ECException
  

  Gets the access vector accessed by this command. This method returns null. It is assumed that only a site administrator will run this command.

  Specified by:

  getResources in interface ECCommand

  Overrides:

  getResources in class AbstractECTargetableCommand

  Returns:

  This method will return null.

  Throws:

  ECException

• performExecute

  public void performExecute()
                      throws ECException
  

  This method sends an email to an individual customer. The email can either be sent immediately, or for better performance, the emails are sent once per day (for the duration of the activity) at the scheduled daily time. A member group is created each day in which the users for that day are placed.

  Specified by:

  performExecute in interface ECCommand

  Specified by:

  performExecute in interface com.ibm.websphere.command.TargetableCommand

  Overrides:

  performExecute in class AbstractECTargetableCommand

  Throws:

  ECException - If anything goes wrong with the data resources being queried.

• validateParameters

  public void validateParameters()
                          throws ECException
  

  This method validates the parameters expected in the request properties. Expected paramters are userId, storeEntityId, emailMessageId, and name. Optional parameters are replyTo and sendImmediate.

  Specified by:

  validateParameters in interface ECCommand

  Overrides:

  validateParameters in class AbstractECTargetableCommand

  Throws:

  ECException - If any of the required parameters are missing.

• setTriggerParameters

  public void setTriggerParameters(java.util.Map parameters)
  

  This method sets the trigger parameters associated with the event that is going to send the e-mail. These parameters are passed to the e-mail JSP.

  Specified by:

  setTriggerParameters in interface EmailIndividualCreateCmd

  Parameters:

  parameters - A map that contains the trigger parameters.

• sendEmailOnSchedule

  protected void sendEmailOnSchedule(java.lang.Integer emailPromotionId,
                         java.lang.Long existingJobId,
                         java.lang.Long storeOwnerId)
  

  This method is used to schedule an email activity include current recipient. It can be overwritten at subclass.

  Parameters:

  emailPromotionId - The integer indicate the email promotion Id.

  existingJobId - The long indicate the related schedule job.

  storeOwnerId - The long input the store owner's id.

• sendEmailDirectly

  protected void sendEmailDirectly(com.ibm.commerce.emarketing.engine.EmailJobKeeper mailJobKeeper)
                            throws ECException
  

  This method is used to send email. It can be overwritten at subclass.

  Parameters:

  mailJobKeeper - The email Job keeper to keep the sending job.

  Throws:

  ECException

• getSendTime

  protected java.lang.String getSendTime()
                                  throws java.lang.Exception
  

  Gets the configured send time using EmailConfigurationTimeDataBean

  Returns:

  A 5-character string in the format HH:mm representing the hour and minute of the configured send time. null is returned if an error occurs or the send time is not configured.

  Throws:

  java.lang.Exception

• getElementId

  public java.lang.Integer getElementId()
  

  This method gets the ID of the element.

  Returns:

  This method returns the ID of the element.

• setElementId

  public void setElementId(java.lang.Integer newElementId)
  

  This method sets the ID of the element.

  Parameters:

  newElementId - The ID of the element.