com.ibm.commerce.marketing.commands.elements

Class EmailIndividualActionTaskCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.marketing.commands.elements.MarketingCampaignElementTaskCmdImpl

com.ibm.commerce.marketing.commands.elements.EmailIndividualActionTaskCmdImpl

All Implemented Interfaces:

EmailIndividualActionTaskCmd, MarketingCampaignElementTaskCmd, 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 EmailIndividualActionTaskCmdImpl
extends MarketingCampaignElementTaskCmdImpl
implements EmailIndividualActionTaskCmd

This command sends an email based on the specified email template to the specified user.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The name of this class.
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	PARAM_SEND_IMMEDIATE Constant to specify the e-mail should be send immediately

Fields inherited from class com.ibm.commerce.marketing.commands.elements.MarketingCampaignElementTaskCmdImpl

DM_FROM_FORWARD_TRIGGERS_FOR_PROCESSING, EMLPROMO_NAME_PREFIX, GENERIC_USER_ID

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.marketing.commands.elements.EmailIndividualActionTaskCmd

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
EmailIndividualActionTaskCmdImpl()

Method Summary

Modifier and Type	Method and Description
static void	cleanup() This method cleans up the thread local resources.
java.lang.Long	getMemberIdToSendEmail() This method returns the member ID to whom to send the e-mail.
void	performExecute() This method sends an email based on the specified email template to the specified user.
java.util.List	validateParameters(java.util.Map elementParameters) This method validates that all the required name value pairs have been set for the campaign element.

Methods inherited from class com.ibm.commerce.marketing.commands.elements.MarketingCampaignElementTaskCmdImpl

addEMarketingSpotDataBean, forwardTriggersForProcessing, forwardTriggersForProcessing, getActivity, getDataFromTriggerParameters, getElementId, getElementParameters, getEMarketingSpotDataBeans, getExperimentTestElements, getMarketingContent, getMarketingSpotBehavior, getMemberId, getMemberId, getMemberIdsForPersonalizationId, getMemberIdsForPersonalizationId, getNewElementParameters, getPersonalizationId, getPreviewReport, getRegisteredMemberIdForPersonalizationId, getReturnValue, getStoreId, getTemporarySharedData, getTemporarySharedDataObject, getTriggerParameters, getTriggerParametersMap, getUserDataForElement, isReadyToCallExecute, putTemporarySharedDataObject, returnEMarketingSpotDataBeans, setActivity, setElementId, setElementParameters, setExperimentTestElements, setNewElementParameter, setOutputProperties, setPreviewReport, setReturnValue, setTemporarySharedData, setTriggerParameters, setTriggerParameters, validateCategory, validateCustomerSegment, validateDates, validateElementIsFirstInActivity, validateEmailTemplate, validateMarketingContent, validateMarketingContent, validateMarketingSpot, validateProduct, validatePromotion, validatePromotionCodes, validatePromotionCodesOrCoupon, validatePromotionCoupon, validatePromotionDisplay, validateSubscription, validateTimes

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, reset, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.marketing.commands.elements.MarketingCampaignElementTaskCmd

forwardTriggersForProcessing, getEMarketingSpotDataBeans, getMarketingSpotBehavior, getNewElementParameters, getReturnValue, returnEMarketingSpotDataBeans, setActivity, setElementId, setElementParameters, setExperimentTestElements, setNewElementParameter, setPreviewReport, setReturnValue, setTemporarySharedData, setTriggerParameters, setTriggerParameters

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.websphere.command.Command

execute, isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

The name of this class.

See Also:

Constant Field Values

PARAM_SEND_IMMEDIATE

public static final java.lang.String PARAM_SEND_IMMEDIATE

Constant to specify the e-mail should be send immediately

See Also:

Constant Field Values

Constructor Detail

EmailIndividualActionTaskCmdImpl

public EmailIndividualActionTaskCmdImpl()

Method Detail

performExecute

public void performExecute()

This method sends an email based on the specified email template to the specified user. The following parameters need to be provided in the task command parameters:

• emailMessageId The email message ID of the template to send as the email.

The following optional parameters can be provided in the task command parameters:

• replyTo The email address to specify as the reply to address.
• sendImmediate Should the email be sent immediately, or once per day at the configured daily time.

This method sets the task command return value to true.

Specified by:

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

Overrides:

performExecute in class MarketingCampaignElementTaskCmdImpl

getMemberIdToSendEmail

public java.lang.Long getMemberIdToSendEmail()

This method returns the member ID to whom to send the e-mail. The default implementation tries to find a registered user associated with the current personalization ID. If none if found, then it tries to find the latest guest user associated with the personalization ID. If none is found, then it returns the current member ID. A customization could override this method if the member ID may not be associated with the personalization ID, for example, to send the e-mail to the Account Representative associated with this users B2B account. Another example is that a specific Sales Representative should be send an e-mail that the customer has places an order for over $100,000.

Specified by:

getMemberIdToSendEmail in interface EmailIndividualActionTaskCmd

Returns:

This method returns a member ID to which the e-mail should be sent. If null is returned, then no e-mail will be sent.

validateParameters

public java.util.List validateParameters(java.util.Map elementParameters)

This method validates that all the required name value pairs have been set for the campaign element. It checks for emailMessageId and replyTo. The value replyTo is not mandatory, however, this method checks that it contains a valid e-mail address. It also checks that the e-mail configuration has been set up for the store.

Specified by:

validateParameters in interface MarketingCampaignElementTaskCmd

Overrides:

validateParameters in class MarketingCampaignElementTaskCmdImpl

Parameters:

elementParameters - The name value pairs for this element.

Returns:

This method returns a list of ApplicationError exceptions that contains any validation errors. The list may be empty or be null.

cleanup

public static void cleanup()

This method cleans up the thread local resources. The command context used when calling the command EmailIndividualCreateCmd is stored in a thread local variable when running under a batch dialog activity.