com.ibm.commerce.experimentation.runtime

Class DynamicEntity

java.lang.Object

com.ibm.commerce.experimentation.runtime.DynamicEntity

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CampaignInitiative

public abstract class DynamicEntity
extends java.lang.Object
implements java.io.Serializable

This class contains all of the common information of business objects that are generated by experiments as displaying content. The business object which extends this abstract class contains all of the information specific to the business type. To add a new business object, extend this abstract class to provide a custom implementation to manage the required fields.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
DynamicEntity()

Method Summary

Modifier and Type	Method and Description
boolean	getControlElementViewed() This method returns the boolean flag that indicates whether or not the control element in the experiment has been viewed.
boolean	getEntityExperimental() This method returns the boolean flag that indicates whether or not the entity is generated by an experiment.
java.lang.Integer	getExperimentId() This method returns the ID of the experiment which generates this business object as its display content.
java.lang.String	getExperimentName() This method returns the name of the experiment which generates this business object as its display content.
java.lang.Integer	getStoreElementTypeId() This method returns the ID of the type of store element on which the experiment is scheduled.
java.lang.Short	getViewedElementId() This method returns the ID of the element that is being viewed in the experiment.
java.lang.String	getViewedElementName() This method returns the name of the element that is being viewed in the experiment.
java.lang.Integer	getViewedElementRatio() This method returns the ratio of the element that is being viewed in the experiment.
void	setControlElementViewed(boolean newControlElementViewed) This method sets the boolean flag that indicates whether or not the control element in the experiment has been viewed.
void	setEntityExperimental(boolean newEntityExperimental) This method sets the boolean flag that indicates whether or not the entity is generated by an experiment.
void	setExperimentId(java.lang.Integer newExperimentId) This method sets the ID of the experiment which generates this business object as its display content.
void	setExperimentName(java.lang.String newExperimentName) This method sets the name of the experiment which generates this business object as its display content.
void	setStoreElementTypeId(java.lang.Integer newStoreElementTypeId) This method sets the ID of the type of store element on which the experiment is scheduled.
void	setViewedElementId(java.lang.Short newViewedElementId) This method sets the ID of the element that is being viewed in the experiment.
void	setViewedElementName(java.lang.String newViewedElementName) This method sets the name of the element that is being viewed in the experiment.
void	setViewedElementRatio(java.lang.Integer newViewedElementRatio) This method sets the ratio of the element that is being viewed in the experiment.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

DynamicEntity

public DynamicEntity()

Method Detail

getControlElementViewed

public boolean getControlElementViewed()

This method returns the boolean flag that indicates whether or not the control element in the experiment has been viewed.

Returns:

True if the control element has been viewed; false if a test element has been viewed.

getEntityExperimental

public boolean getEntityExperimental()

This method returns the boolean flag that indicates whether or not the entity is generated by an experiment.

Returns:

True if entity is generated by an experiment; false otherwise.

getExperimentId

public java.lang.Integer getExperimentId()

This method returns the ID of the experiment which generates this business object as its display content.

Returns:

The experiment ID.

getExperimentName

public java.lang.String getExperimentName()

This method returns the name of the experiment which generates this business object as its display content.

Returns:

The experiment name.

getStoreElementTypeId

public java.lang.Integer getStoreElementTypeId()

This method returns the ID of the type of store element on which the experiment is scheduled.

Returns:

The ID of the store element type.

getViewedElementId

public java.lang.Short getViewedElementId()

This method returns the ID of the element that is being viewed in the experiment.

Returns:

The ID of the viewed element.

getViewedElementName

public java.lang.String getViewedElementName()

This method returns the name of the element that is being viewed in the experiment.

Returns:

The name of the viewed element.

getViewedElementRatio

public java.lang.Integer getViewedElementRatio()

This method returns the ratio of the element that is being viewed in the experiment.

Returns:

The ratio of the viewed element.

setControlElementViewed

public void setControlElementViewed(boolean newControlElementViewed)

This method sets the boolean flag that indicates whether or not the control element in the experiment has been viewed.

Parameters:

newControlElementViewed - True if control element has been viewed; false if a test element has been viewed.

setEntityExperimental

public void setEntityExperimental(boolean newEntityExperimental)

This method sets the boolean flag that indicates whether or not the entity is generated by an experiment.

Parameters:

newEntityExperimental - True if entity is generated by an experiment; false otherwise.

setExperimentId

public void setExperimentId(java.lang.Integer newExperimentId)

This method sets the ID of the experiment which generates this business object as its display content.

Parameters:

newExperimentId - The experiment ID.

setExperimentName

public void setExperimentName(java.lang.String newExperimentName)

This method sets the name of the experiment which generates this business object as its display content.

Parameters:

newExperimentName - The experiment name.

setStoreElementTypeId

public void setStoreElementTypeId(java.lang.Integer newStoreElementTypeId)

This method sets the ID of the type of store element on which the experiment is scheduled.

Parameters:

newStoreElementTypeId - The ID of the store element type.

setViewedElementId

public void setViewedElementId(java.lang.Short newViewedElementId)

This method sets the ID of the element that is being viewed in the experiment.

Parameters:

newViewedElementId - The ID of the viewed element.

setViewedElementName

public void setViewedElementName(java.lang.String newViewedElementName)

This method sets the name of the element that is being viewed in the experiment.

Parameters:

newViewedElementName - The name of the viewed element.

setViewedElementRatio

public void setViewedElementRatio(java.lang.Integer newViewedElementRatio)

This method sets the ratio of the element that is being viewed in the experiment.

Parameters:

newViewedElementRatio - The ratio of the viewed element.