com.ibm.commerce.marketing.commands.elements

Class AddToRemoveFromSegmentActionTaskCmdImpl

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

All Implemented Interfaces:

AddToRemoveFromSegmentActionTaskCmd, 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 AddToRemoveFromSegmentActionTaskCmdImpl
extends MarketingCampaignElementTaskCmdImpl
implements AddToRemoveFromSegmentActionTaskCmd

This command adds a user to or removes them from a Customer Segment. The customer is associated to the customer segment by their personalization ID.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ADD Constant to specify the action is add to Segment.
static java.lang.String	ACTION_REMOVE Constant to specify the action is remove from Segment.
static java.lang.String	CLASSNAME The name of this class.
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	PARAM_ACTION Constant to specify the action parameter in the task command input parameters.
static java.lang.String	PARAM_CUSTOMER_SEGMENT_ID_LIST Constant to specify the segmentIdList parameter in the task command input parameters.

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

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AddToRemoveFromSegmentActionTaskCmdImpl() This method is the default constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPersonalizationIdForSegment() This method returns the personalization ID to whom to add to or remove from the segment.
void	performExecute() This method adds members to or removes them from a Customer Segment.
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_CUSTOMER_SEGMENT_ID_LIST

public static final java.lang.String PARAM_CUSTOMER_SEGMENT_ID_LIST

Constant to specify the segmentIdList parameter in the task command input parameters.

See Also:

Constant Field Values

PARAM_ACTION

public static final java.lang.String PARAM_ACTION

Constant to specify the action parameter in the task command input parameters.

See Also:

Constant Field Values

ACTION_ADD

public static final java.lang.String ACTION_ADD

Constant to specify the action is add to Segment.

See Also:

Constant Field Values

ACTION_REMOVE

public static final java.lang.String ACTION_REMOVE

Constant to specify the action is remove from Segment.

See Also:

Constant Field Values

Constructor Detail

AddToRemoveFromSegmentActionTaskCmdImpl

public AddToRemoveFromSegmentActionTaskCmdImpl()

This method is the default constructor. It currently performs no actions.

Method Detail

getPersonalizationIdForSegment

public java.lang.String getPersonalizationIdForSegment()

This method returns the personalization ID to whom to add to or remove from the segment. The default implementation gets the personalization ID of the current user from the context. A customization could override this method to add or remove a different customer, for example, to add the customer who referred this customer.

Returns:

This method returns a personalization ID to whom to add to or remove from the segment. If null is returned, then no action will be performed.

performExecute

public void performExecute()

This method adds members to or removes them from a Customer Segment.

Specified by:

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

Overrides:

performExecute in class MarketingCampaignElementTaskCmdImpl

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 action and segmentIdList. As well, the customer segment must have selected the option to allow marketing to populate the customer segment.

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.