Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  Copyright.

  See Also:

  Constant Field Values

Constructor Detail

• ListEmailRecipientsInMemberGroupTaskCmdImpl

  public ListEmailRecipientsInMemberGroupTaskCmdImpl()
  

Method Detail

• performExecute

  public void performExecute()
                      throws ECException
  

  Runs this command.

  Specified by:

  performExecute in interface ECCommand

  Specified by:

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

  Overrides:

  performExecute in class AbstractECTargetableCommand

  Throws:

  ECSystemException - Thrown when MemberGroupAccessBean cannot retreive data, or when or ListUsersInMemberGroupCmd cannot execute successfully.

  ECException

• setMemberGroupId

  public void setMemberGroupId(java.lang.Long memberGroupId)
  

  Sets the member group ID of the customer profile from which to create EmailRecipient objects.

  Specified by:

  setMemberGroupId in interface ListEmailRecipientsInMemberGroupTaskCmd

  Parameters:

  memberGroupId - The member group ID.

• getEmailRecipients

  public java.util.List getEmailRecipients()
  

  Returns a list of EmailRecipient objects created from the customer segment.

  Specified by:

  getEmailRecipients in interface ListEmailRecipientsInMemberGroupTaskCmd

  Specified by:

  getEmailRecipients in interface com.ibm.commerce.emarketing.engine.EmailRecipientSupplier

  Returns:

  the list of EmailRecipient objects created from the customer segment.

• setQueryOnly

  public void setQueryOnly(boolean flag)
  

  Defers executing the query generated for querying members of the group to the caller. Useful when the caller wishes to manage the database connection and result set. The caller should use getQuery() to retreive the resulting SQL.

  Specified by:

  setQueryOnly in interface ListEmailRecipientsInMemberGroupTaskCmd

  Parameters:

  flag - Set to true if only the SQL query is required, false otherwise.

• getQuery

  public java.lang.String getQuery()
  

  Returns the SQL query used to generate the list of members in the group.

  Specified by:

  getQuery in interface com.ibm.commerce.emarketing.engine.EmailRecipientSupplier

  Returns:

  the SQL query used to generate the list of members in the group.

• isReadyToCallExecute

  public boolean isReadyToCallExecute()
  

  Checks if this command is ready to execute.

  Specified by:

  isReadyToCallExecute in interface com.ibm.websphere.command.Command

  Overrides:

  isReadyToCallExecute in class AbstractECTargetableCommand

  Returns:

  True if the member group ID passed is not null; false otherwise.

• setStoreEntityId

  public void setStoreEntityId(java.lang.Integer storeId)
  

  Sets the store entity ID.

  Specified by:

  setStoreEntityId in interface ListEmailRecipientsInMemberGroupTaskCmd

  Parameters:

  storeId - The store entity ID.

• setUserId

  public void setUserId(java.lang.Long userId)
  

  Sets the user ID.

  Specified by:

  setUserId in interface ListEmailRecipientsInMemberGroupTaskCmd

  Parameters:

  userId - The user ID.

• getQueryToFindMemberIdAndEmailForIndividualUser

  protected java.lang.String getQueryToFindMemberIdAndEmailForIndividualUser(java.lang.Integer storeId,
                                                                 java.lang.Long userId)
  

  This method is called in a dialog activity when sending an e-mail to an individual customer. It is only called when the "Send immediately" checkbox is selected. The purpose of this method is to construct a SQL statement that will be run to find the e-mail address to which to send the e-mail. The SELECT part of the SQL statement must return three fields: a Long that has the customer's MEMBER_ID, a String with the e-mail address, and a String with an alternate e-mail address. Either e-mail address may be null or an empty string. By default, this method returns a SQL that will find the e-mail address of a registered customer who has opted in to receive marketing e-mail. The following is the SQL that is returned:

   "SELECT MEMBER_ID, EMAIL1, EMAIL2 FROM ADDRESS WHERE MEMBER_ID = " + userId + " 
   AND MEMBER_ID = any (SELECT USERS_ID FROM EMLUSRRECV WHERE USERS_ID = " + userId + " AND ((RECEIVEEML = 1 AND STOREENT_ID = " + storeId + ") 
   or (RECEIVEEML = 1 AND STOREENT_ID = 0)) and 
   USERS_ID NOT IN (SELECT USERS_ID FROM EMLUSRRECV WHERE USERS_ID = " + userId + " AND RECEIVEEML = 0 AND STOREENT_ID = " + storeId + ")) 
   AND SELFADDRESS = 1 AND STATUS = 'P'"
   
  

  A customization may want to have different behavior. For example, you may want to allow sending e-mail to a guest shopper who has filled in their address during checkout. The following example shows an SQL that could be used in that scenario:

   "SELECT MEMBER_ID, EMAIL1, EMAIL2 FROM USERS, ADDRESS WHERE USERS.USERS_ID = " + userId + " 
   AND USERS.USERS_ID = ADDRESS.MEMBER_ID AND ( (USERS.REGISTERTYPE = 'G' AND ADDRESS.STATUS = 'P') OR
   (USERS.REGISTERTYPE = 'R' AND ADDRESS.MEMBER_ID = any (SELECT USERS_ID FROM EMLUSRRECV WHERE USERS_ID = " + userId + " 
   AND ((RECEIVEEML = 1 AND STOREENT_ID = " + storeId + ") 
   or (RECEIVEEML = 1 AND STOREENT_ID = 0)) and 
   USERS_ID NOT IN (SELECT USERS_ID FROM EMLUSRRECV WHERE USERS_ID = " + userId + " AND RECEIVEEML = 0 AND STOREENT_ID = " + storeId + "))
   AND SELFADDRESS = 1 AND STATUS = 'P') )"
   
  

  Parameters:

  storeId - The ID of the store.

  userId - The ID of the customer to whom to send the e-mail.

  Returns:

  A String containing a SQL statement that will be run to find the e-mail address to which to send the e-mail.

• setMemberGroupIds

  public void setMemberGroupIds(java.lang.String[] mbrGrpIds,
                       java.lang.String anyOrAll)
  

  This method sets the additonal member group IDs of the customer segment to which to send the the bulk email. These IDs are in addition to the member group passed in through the request property parameter memberGroupId to this command.

  Specified by:

  setMemberGroupIds in interface ListEmailRecipientsInMemberGroupTaskCmd

  Parameters:

  mbrGrpIds - The set of IDs of the member groups to which to send the bulk email.

  anyOrAll - Should the email be sent to the customers in each of the specified groups (any), or should the email be sent to those who are in all of the specified groups (all). Valid values are: any, all.