com.ibm.commerce.marketing.commands.elements

Class ReturnNvpActionTaskCmdImpl

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

All Implemented Interfaces:

MarketingCampaignElementTaskCmd, ReturnNvpActionTaskCmd, 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 ReturnNvpActionTaskCmdImpl
extends MarketingCampaignElementTaskCmdImpl
implements ReturnNvpActionTaskCmd

This command sets which data should be returned to an e-Marketing Spot. This can be any name value pair which provides information to the e-Marketing Spot JSP snippet. In the SDO returned in the Get MarketingSpotData service, there will be a BaseMarketingSpotActivityDataType with a data type of DM_NVP and a unique ID of DM_NVP. The name value pairs will be in the properties element. For example, if a name value pair is set with the name ABC, then the following code can retrieve the value in the e-Marketing Spot JSP snippet.

 ${marketingSpotData.properties['ABC']}
 

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

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMarketingSpotBehavior(java.util.Map elementParameters) This method returns a value of 0 to specify that this marketing campaign element is static and the results can be cached for all users.
void	performExecute() This method sets which data should be returned to an e-Marketing Spot.
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, 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, 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.

Constructor Detail

ReturnNvpActionTaskCmdImpl

public ReturnNvpActionTaskCmdImpl()

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

Method Detail

performExecute

public void performExecute()

This method sets which data should be returned to an e-Marketing Spot.

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 nvpName and nvpValue.

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.

getMarketingSpotBehavior

public java.lang.String getMarketingSpotBehavior(java.util.Map elementParameters)

This method returns a value of 0 to specify that this marketing campaign element is static and the results can be cached for all users.

Specified by:

getMarketingSpotBehavior in interface MarketingCampaignElementTaskCmd

Overrides:

getMarketingSpotBehavior in class MarketingCampaignElementTaskCmdImpl

Parameters:

elementParameters - The name value pairs for this element.

Returns:

This method returns a value of 0.