com.ibm.commerce.marketing.runtime.util

Class ExperimentDataBean

java.lang.Object

com.ibm.commerce.marketing.runtime.util.ExperimentDataBean

All Implemented Interfaces:

com.ibm.websphere.cache.Sizeable, java.io.Serializable

public class ExperimentDataBean
extends java.lang.Object
implements java.io.Serializable, com.ibm.websphere.cache.Sizeable

This data bean encapsulates the information of an experiment which resulted in data being displayed in an e-Marketing Spot. The Marketing engine actions will populate this bean when performing a recommendation action in an activity flow. It is not expected that a customization would need to use this class directly. It is generally passed from MarketingCampaignElementTaskCmdImpl.getExperimentTestElements to the EMarketingSpotDataBean constructor.

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.

Constructor Summary

Constructors

Constructor and Description
ExperimentDataBean() This method is the default constructor.
ExperimentDataBean(java.lang.String newExperimentId, java.lang.String newExperimentName, java.lang.String newTestElementId, java.lang.String newTestElementName, boolean newControl) This method initializes the bean with all the information of the experiment that resulted in data being displayed in an e-Marketing Spot.

Method Summary

Modifier and Type	Method and Description
boolean	getControl() This method gets if the test element is a control test element.
java.lang.String	getExperimentId() This method gets the ID of the experiment which resulted in data being displayed in an eMarketing Spot.
java.lang.String	getExperimentName() This method gets the name of the experiment which resulted in data being displayed in an eMarketing Spot.
long	getObjectSize() Returns the estimated footprint size in bytes of this object and the objects it contains.
java.lang.String	getTestElementId() This method gets the ID of the test element which resulted in data being displayed in an eMarketing Spot.
java.lang.String	getTestElementName() This method gets the name of the test element which resulted in data being displayed in an eMarketing Spot.
void	setControl(boolean newControl) This method sets if the test element is a control test element.
void	setExperimentId(java.lang.String newExperimentId) This method sets the ID of the experiment which resulted in data being displayed in an eMarketing Spot.
void	setExperimentName(java.lang.String newExperimentName) This method sets the name of the experiment which resulted in data being displayed in an eMarketing Spot.
void	setTestElementId(java.lang.String newTestElementId) This method sets the ID of the test element which resulted in data being displayed in an eMarketing Spot.
void	setTestElementName(java.lang.String newTestElementName) This method sets the name of the test element which resulted in data being displayed in an eMarketing Spot.
java.lang.String	toString() This method returns a string with the content of the experiment data.

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

The name of this class.

See Also:

Constant Field Values

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ExperimentDataBean

public ExperimentDataBean()

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

ExperimentDataBean

public ExperimentDataBean(java.lang.String newExperimentId,
                          java.lang.String newExperimentName,
                          java.lang.String newTestElementId,
                          java.lang.String newTestElementName,
                          boolean newControl)

This method initializes the bean with all the information of the experiment that resulted in data being displayed in an e-Marketing Spot.

Parameters:

newExperimentId - The ID of the experiment.

newExperimentName - The name of the experiment.

newTestElementId - The ID of the test element.

newTestElementName - The name of the test element.

newControl - If the test element is the control test element.

Method Detail

getObjectSize

public long getObjectSize()

Returns the estimated footprint size in bytes of this object and the objects it contains.

Specified by:

getObjectSize in interface com.ibm.websphere.cache.Sizeable

Returns:

the estimated footprint size in bytes or -1 if a size cannot be determined.

getExperimentId

public java.lang.String getExperimentId()

This method gets the ID of the experiment which resulted in data being displayed in an eMarketing Spot.

Returns:

This method returns the ID of the experiment which resulted in data being displayed in an eMarketing Spot.

getExperimentName

public java.lang.String getExperimentName()

This method gets the name of the experiment which resulted in data being displayed in an eMarketing Spot.

Returns:

This method returns the name of the experiment which resulted in data being displayed in an eMarketing Spot.

getTestElementId

public java.lang.String getTestElementId()

This method gets the ID of the test element which resulted in data being displayed in an eMarketing Spot.

Returns:

This method returns the ID of the test element which resulted in data being displayed in an eMarketing Spot.

getTestElementName

public java.lang.String getTestElementName()

This method gets the name of the test element which resulted in data being displayed in an eMarketing Spot.

Returns:

This method returns the name of the test element which resulted in data being displayed in an eMarketing Spot.

getControl

public boolean getControl()

This method gets if the test element is a control test element.

Returns:

This method returns if the test element is a control test element.

setExperimentId

public void setExperimentId(java.lang.String newExperimentId)

This method sets the ID of the experiment which resulted in data being displayed in an eMarketing Spot.

Parameters:

newExperimentId - The ID of the experiment which resulted in data being displayed in an eMarketing Spot.

setExperimentName

public void setExperimentName(java.lang.String newExperimentName)

This method sets the name of the experiment which resulted in data being displayed in an eMarketing Spot.

Parameters:

newExperimentName - The name of the experiment which resulted in data being displayed in an eMarketing Spot.

setTestElementId

public void setTestElementId(java.lang.String newTestElementId)

This method sets the ID of the test element which resulted in data being displayed in an eMarketing Spot.

Parameters:

newTestElementId - The ID of the test element which resulted in data being displayed in an eMarketing Spot.

setTestElementName

public void setTestElementName(java.lang.String newTestElementName)

This method sets the name of the test element which resulted in data being displayed in an eMarketing Spot.

Parameters:

newTestElementName - The name of the test element which resulted in data being displayed in an eMarketing Spot.

setControl

public void setControl(boolean newControl)

This method sets if the test element is a control test element.

Parameters:

newControl - If the test element is a control test element.

toString

public java.lang.String toString()

This method returns a string with the content of the experiment data.

Overrides:

toString in class java.lang.Object

Returns:

This method returns a string with the content of the experiment data.