com.ibm.commerce.marketing.commands.elements

Class CustomerAbandonsShoppingCartTriggerTaskCmdImpl

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.CustomerAbandonsShoppingCartTriggerTaskCmdImpl

All Implemented Interfaces:

CustomerAbandonsShoppingCartTriggerTaskCmd, 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 CustomerAbandonsShoppingCartTriggerTaskCmdImpl
extends MarketingCampaignElementTaskCmdImpl
implements CustomerAbandonsShoppingCartTriggerTaskCmd

This command validates the Customer Abandons Shopping Cart Trigger at activity activation, and raises triggers for customers who have abandoned their shopping cart.

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.

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.CustomerAbandonsShoppingCartTriggerTaskCmd

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CustomerAbandonsShoppingCartTriggerTaskCmdImpl()

Method Summary

Modifier and Type	Method and Description
void	forwardTriggersForProcessing() This method finds all the customers who have abandoned their shopping cart, and forwards the trigger to the marketing services for each customer.
java.util.List	getOwnersOfAbandonedShoppingCarts(java.lang.Integer storeId, java.lang.String afterDate, java.lang.String beforeDate) This method gets the member IDs and personalization IDs for customers who have abandoned their shopping cart.
void	processAbandonedCartsInStore(java.lang.Integer storeId, java.lang.Integer elementId, java.lang.Integer activityId) This method finds all the users who have abandoned their shopping cart, and forwards the trigger for each 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, getActivity, getDataFromTriggerParameters, getElementId, getElementParameters, getEMarketingSpotDataBeans, getExperimentTestElements, getMarketingContent, getMarketingSpotBehavior, getMemberId, getMemberId, getMemberIdsForPersonalizationId, getMemberIdsForPersonalizationId, getNewElementParameters, getPersonalizationId, getPreviewReport, getRegisteredMemberIdForPersonalizationId, getReturnValue, getStoreId, getTemporarySharedData, getTemporarySharedDataObject, getTriggerParameters, getTriggerParametersMap, getUserDataForElement, isReadyToCallExecute, performExecute, 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

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, performExecute, 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

Constructor Detail

CustomerAbandonsShoppingCartTriggerTaskCmdImpl

public CustomerAbandonsShoppingCartTriggerTaskCmdImpl()

Method Detail

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 numberOfDays and repeatSchedule. If the repeatSchedule is runOnce, then the parameter maximumNumberOfDaysCartHasBeenAbandoned is required and this element must be the first element in the activity flow. As well, there can only be one element in the activity that has the runOnce repeat schedule defined.

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.

forwardTriggersForProcessing

public void forwardTriggersForProcessing()

This method finds all the customers who have abandoned their shopping cart, and forwards the trigger to the marketing services for each customer. If the activity is defined in a Storefront Asset Store, then the customers are found in each extended site that refers to the Storefront Asset Store with a 'com.ibm.commerce.campaigns' relationship.

Specified by:

forwardTriggersForProcessing in interface MarketingCampaignElementTaskCmd

Overrides:

forwardTriggersForProcessing in class MarketingCampaignElementTaskCmdImpl

processAbandonedCartsInStore

public void processAbandonedCartsInStore(java.lang.Integer storeId,
                                         java.lang.Integer elementId,
                                         java.lang.Integer activityId)
                                  throws java.lang.Exception

This method finds all the users who have abandoned their shopping cart, and forwards the trigger for each user.

Parameters:

storeId - The identifier of the store in which to find the users in the segment.

elementId - The identifier of the trigger element.

activityId - The identifier of the marketing activity.

Throws:

java.lang.Exception

getOwnersOfAbandonedShoppingCarts

public java.util.List getOwnersOfAbandonedShoppingCarts(java.lang.Integer storeId,
                                                        java.lang.String afterDate,
                                                        java.lang.String beforeDate)
                                                 throws java.lang.Exception

This method gets the member IDs and personalization IDs for customers who have abandoned their shopping cart. An abandoned shopping cart is one whose last update date is before the date specified in the beforeDate parameter. The afterDate parameter restricts the query to find carts whose last update date is between afterDate and before beforeDate.

Parameters:

storeId - The unique ID of the store.

afterDate - The oldest value allowed for the shopping cart last update date.

beforeDate - The most recent value allowed for the shopping cart last update date.

Returns:

This method returns the list with the customer information. Every element in the list is a child-list; in the child-list, the 1st element is the customer's member ID, and the 2nd element is the customer's personalization ID.

Throws:

java.lang.Exception