com.ibm.commerce.marketing.commands.elements

Class BranchTaskCmdImpl

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

All Implemented Interfaces:

BranchTaskCmd, 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 BranchTaskCmdImpl
extends MarketingCampaignElementTaskCmdImpl
implements BranchTaskCmd

This class validates if all the required name value pairs have been set on a Branch campaign element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BRANCH_TYPE_ALL Constant representing the "all" type of an activity branch.
static java.lang.String	BRANCH_TYPE_ANY Constant representing the "any" type of an activity branch.
static java.lang.String	BRANCH_TYPE_ONE Constant representing the "one" type of an activity branch.
static java.lang.String	BRANCH_TYPE_RANDOM Constant representing the random type of activity branch.
static java.lang.String	CLASSNAME The name of this class.
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	EXPERIMENT_ENDDATE Constant representing the experiment endDate attribute in the branch element name value pairs.
static java.lang.String	EXPERIMENT_SESSIONLENGTH Constant representing the experiment sessionLength attribute in the branch element name value pairs.
static java.lang.String	EXPERIMENT_STARTDATE Constant representing the experiment startDate attribute in the branch element name value pairs.
static java.lang.String	EXPERIMENT_STATE Constant representing the experiment state attribute in the branch element name value pairs.
static java.lang.String	EXPERIMENT_STATE_ACTIVE Constant representing the active state of an experiment.
static java.lang.String	PARAM_BRANCHTYPE Constant representing the type of an activity branch.
static java.lang.String	PARAM_MAX_CUSTOMERS Constant representing the experiment maxCustomers attribute in the branch element name value pairs.
static java.lang.String	PARAM_PERCENTAGE Constant representing the percentage for a path of a random type activity branch.
static java.lang.String	PARAM_SCOPE Constant representing the experiment scope attribute in the branch element name value pairs.
static java.lang.String	SCOPE_LIFETIME Constant representing the experiment lifetime scope attribute in the branch element name value pairs.
static java.lang.String	SCOPE_REQUEST Constant representing the experiment request scope attribute in the branch element name value pairs.
static java.lang.String	SCOPE_SESSION Constant representing the experiment session scope attribute in the branch element name value pairs.

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

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
BranchTaskCmdImpl()

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 when the branch is a regular branch of type any or all.
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, 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

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

PARAM_BRANCHTYPE

public static final java.lang.String PARAM_BRANCHTYPE

Constant representing the type of an activity branch.

See Also:

Constant Field Values

BRANCH_TYPE_RANDOM

public static final java.lang.String BRANCH_TYPE_RANDOM

Constant representing the random type of activity branch.

See Also:

Constant Field Values

BRANCH_TYPE_ONE

public static final java.lang.String BRANCH_TYPE_ONE

Constant representing the "one" type of an activity branch.

See Also:

Constant Field Values

BRANCH_TYPE_ANY

public static final java.lang.String BRANCH_TYPE_ANY

Constant representing the "any" type of an activity branch.

See Also:

Constant Field Values

BRANCH_TYPE_ALL

public static final java.lang.String BRANCH_TYPE_ALL

Constant representing the "all" type of an activity branch.

See Also:

Constant Field Values

PARAM_PERCENTAGE

public static final java.lang.String PARAM_PERCENTAGE

Constant representing the percentage for a path of a random type activity branch.

See Also:

Constant Field Values

PARAM_SCOPE

public static final java.lang.String PARAM_SCOPE

Constant representing the experiment scope attribute in the branch element name value pairs.

See Also:

Constant Field Values

SCOPE_LIFETIME

public static final java.lang.String SCOPE_LIFETIME

Constant representing the experiment lifetime scope attribute in the branch element name value pairs.

See Also:

Constant Field Values

SCOPE_SESSION

public static final java.lang.String SCOPE_SESSION

Constant representing the experiment session scope attribute in the branch element name value pairs.

See Also:

Constant Field Values

SCOPE_REQUEST

public static final java.lang.String SCOPE_REQUEST

Constant representing the experiment request scope attribute in the branch element name value pairs.

See Also:

Constant Field Values

EXPERIMENT_STARTDATE

public static final java.lang.String EXPERIMENT_STARTDATE

Constant representing the experiment startDate attribute in the branch element name value pairs.

See Also:

Constant Field Values

EXPERIMENT_ENDDATE

public static final java.lang.String EXPERIMENT_ENDDATE

Constant representing the experiment endDate attribute in the branch element name value pairs.

See Also:

Constant Field Values

PARAM_MAX_CUSTOMERS

public static final java.lang.String PARAM_MAX_CUSTOMERS

Constant representing the experiment maxCustomers attribute in the branch element name value pairs.

See Also:

Constant Field Values

EXPERIMENT_STATE

public static final java.lang.String EXPERIMENT_STATE

Constant representing the experiment state attribute in the branch element name value pairs.

See Also:

Constant Field Values

EXPERIMENT_SESSIONLENGTH

public static final java.lang.String EXPERIMENT_SESSIONLENGTH

Constant representing the experiment sessionLength attribute in the branch element name value pairs.

See Also:

Constant Field Values

EXPERIMENT_STATE_ACTIVE

public static final java.lang.String EXPERIMENT_STATE_ACTIVE

Constant representing the active state of an experiment.

See Also:

Constant Field Values

Constructor Detail

BranchTaskCmdImpl

public BranchTaskCmdImpl()

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 that branchtype has been set. If the scope variable is set, then one of endDate or maxCustomers needs to be set. For a random branch, the sum of the percentages on all the paths must total 100.

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 when the branch is a regular branch of type any or all. This method returns a value of 1 to specify that this marketing campaign element is dynamic when the branch is a regular branch of type random or when the branch is an experiment.

Specified by:

getMarketingSpotBehavior in interface MarketingCampaignElementTaskCmd

Overrides:

getMarketingSpotBehavior in class MarketingCampaignElementTaskCmdImpl

Parameters:

elementParameters - The name value pairs for this element.

Returns:

This method returns the behavior of the branch element.