com.ibm.commerce.experimentation.registry

Class ExperimentCache

java.lang.Object

com.ibm.commerce.experimentation.registry.ExperimentCache

public class ExperimentCache
extends java.lang.Object

This class contains fields and access methods of an experiment which is used in the experiment cache registry.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description

ExperimentCache(java.lang.Integer newExperimentId, java.lang.String newExperimentName, java.lang.String newDescription, java.lang.Integer newStoreId, java.lang.Integer newStoreElementTypeId, java.lang.Short newPriority, java.lang.Integer newExpireCount, java.sql.Timestamp newStartDate, java.sql.Timestamp newEndDate, java.lang.Short newPreferredElement, java.lang.String newResultScope, java.lang.String newStatus, ExperimentRuleDefinition newRuleDefinition) This constructor takes the content of a cached experiment.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() This method returns the description of the experiment.
java.sql.Timestamp	getEndDate() This method returns the end date of the experiment.
java.lang.Integer	getExperimentId() This method returns the ID of the experiment.
java.lang.String	getExperimentName() This method returns the name of the experiment.
java.lang.Integer	getExpireCount() This method returns the expire count of the experiment, which is used to determine when the experiment is expired.
java.lang.Short	getPreferredElement() This method returns the preferred element of the experiment.
java.lang.Short	getPriority() This method returns the priority of the experiment.
java.lang.String	getResultScope() This method returns the result scope of the experiment.
ExperimentRuleDefinition	getRuleDefinition() This method returns the rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.
java.sql.Timestamp	getStartDate() This method returns the start date of the experiment.
java.lang.String	getStatus() This method returns the status of the experiment.
java.lang.Integer	getStoreElementTypeId() This method returns the ID of the type that the store element selected in the experiment is assigned to.
java.lang.Integer	getStoreId() This method returns the ID of the store to which this experiment belongs.
void	setDescription(java.lang.String newDescription) This method sets the description of the experiment.
void	setEndDate(java.sql.Timestamp newEndDate) This method sets the end date of the experiment.
void	setExperimentId(java.lang.Integer newExperimentId) This method sets the ID of the experiment.
void	setExperimentName(java.lang.String newExperimentName) This method sets the name of the experiment.
void	setExpireCount(java.lang.Integer newExpireCount) This method sets the expire count of the experiment, which is used to determine when the experiment would be expired.
void	setPreferredElement(java.lang.Short newPreferredElement) This method sets the preferred element of the experiment.
void	setPriority(java.lang.Short newPriority) This method sets the priority of the experiment.
void	setResultScope(java.lang.String newResultScope) This method sets the result scope of the experiment.
void	setRuleDefinition(ExperimentRuleDefinition newRuleDefinition) This method sets the rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.
void	setStartDate(java.sql.Timestamp newStartDate) This method sets the start date of the experiment.
void	setStatus(java.lang.String newStatus) This method sets the status of the experiment.
void	setStoreElementTypeId(java.lang.Integer newStoreElementTypeId) This method sets the ID of the type to which the store element selected in the experiment is assigned.
void	setStoreId(java.lang.Integer newStoreId) This method sets the ID of the store to which this experiment belongs.

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

ExperimentCache

public ExperimentCache(java.lang.Integer newExperimentId,
                       java.lang.String newExperimentName,
                       java.lang.String newDescription,
                       java.lang.Integer newStoreId,
                       java.lang.Integer newStoreElementTypeId,
                       java.lang.Short newPriority,
                       java.lang.Integer newExpireCount,
                       java.sql.Timestamp newStartDate,
                       java.sql.Timestamp newEndDate,
                       java.lang.Short newPreferredElement,
                       java.lang.String newResultScope,
                       java.lang.String newStatus,
                       ExperimentRuleDefinition newRuleDefinition)

This constructor takes the content of a cached experiment.

Parameters:

newExperimentId - The ID of the cached experiment.

newExperimentName - The name of the cached experiment.

newDescription - The description of the cached experiment.

newStoreId - The store ID of the cached experiment.

newStoreElementTypeId - The store element type ID of the cached experiment.

newPriority - The priority of the cached experiment.

newExpireCount - The expire count of the cached experiment.

newStartDate - The start date of the cached experiment.

newEndDate - The end date of the cached experiment.

newPreferredElement - The preferred element of the cached experiment.

newResultScope - The result scope of the cached experiment.

newStatus - The status of the cached experiment.

newRuleDefinition - The rule definition instance of the cached experiment.

Method Detail

getDescription

public java.lang.String getDescription()

This method returns the description of the experiment.

Returns:

The description of the experiment.

getEndDate

public java.sql.Timestamp getEndDate()

This method returns the end date of the experiment.

Returns:

The end date of the experiment.

getExperimentId

public java.lang.Integer getExperimentId()

This method returns the ID of the experiment.

Returns:

The ID of the experiment.

getExperimentName

public java.lang.String getExperimentName()

This method returns the name of the experiment.

Returns:

The name of the experiment.

getExpireCount

public java.lang.Integer getExpireCount()

This method returns the expire count of the experiment, which is used to determine when the experiment is expired. That is, after the number of customers who viewed the experiment is reached.

Returns:

The expire count of the experiment.

getPreferredElement

public java.lang.Short getPreferredElement()

This method returns the preferred element of the experiment.

Returns:

The preferred element of the experiment.

getPriority

public java.lang.Short getPriority()

This method returns the priority of the experiment.

Returns:

The priority of the experiment.

getResultScope

public java.lang.String getResultScope()

This method returns the result scope of the experiment.

Returns:

The result scope of the experiment.

getRuleDefinition

public ExperimentRuleDefinition getRuleDefinition()

This method returns the rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.

Returns:

Rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.

getStartDate

public java.sql.Timestamp getStartDate()

This method returns the start date of the experiment.

Returns:

The start date of the experiment.

getStatus

public java.lang.String getStatus()

This method returns the status of the experiment.

Returns:

The status of the experiment.

getStoreElementTypeId

public java.lang.Integer getStoreElementTypeId()

This method returns the ID of the type that the store element selected in the experiment is assigned to.

Returns:

The ID of the type to which the store element selected in the experiment is assigned.

getStoreId

public java.lang.Integer getStoreId()

This method returns the ID of the store to which this experiment belongs.

Returns:

The ID of the store to which this experiment belongs.

setDescription

public void setDescription(java.lang.String newDescription)

This method sets the description of the experiment.

Parameters:

newDescription - The description of the experiment.

setEndDate

public void setEndDate(java.sql.Timestamp newEndDate)

This method sets the end date of the experiment.

Parameters:

newEndDate - The end date of the experiment.

setExperimentId

public void setExperimentId(java.lang.Integer newExperimentId)

This method sets the ID of the experiment.

Parameters:

newExperimentId - The ID of the experiment.

setExperimentName

public void setExperimentName(java.lang.String newExperimentName)

This method sets the name of the experiment.

Parameters:

newExperimentName - The name of the experiment.

setExpireCount

public void setExpireCount(java.lang.Integer newExpireCount)

This method sets the expire count of the experiment, which is used to determine when the experiment would be expired. That is, after the number of customers who viewed the experiment is reached.

Parameters:

newExpireCount - The expire count of the experiment.

setPreferredElement

public void setPreferredElement(java.lang.Short newPreferredElement)

This method sets the preferred element of the experiment.

Parameters:

newPreferredElement - The preferred element of the experiment.

setPriority

public void setPriority(java.lang.Short newPriority)

This method sets the priority of the experiment.

Parameters:

newPriority - The priority of the experiment.

setResultScope

public void setResultScope(java.lang.String newResultScope)

This method sets the result scope of the experiment.

Parameters:

newResultScope - The result scope of the experiment.

setRuleDefinition

public void setRuleDefinition(ExperimentRuleDefinition newRuleDefinition)

This method sets the rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.

Parameters:

newRuleDefinition - The rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.

setStartDate

public void setStartDate(java.sql.Timestamp newStartDate)

This method sets the start date of the experiment.

Parameters:

newStartDate - The start date of the experiment.

setStatus

public void setStatus(java.lang.String newStatus)

This method sets the status of the experiment.

Parameters:

newStatus - The status of the experiment.

setStoreElementTypeId

public void setStoreElementTypeId(java.lang.Integer newStoreElementTypeId)

This method sets the ID of the type to which the store element selected in the experiment is assigned.

Parameters:

newStoreElementTypeId - The ID of the type to which the store element selected in the experiment is assigned.

setStoreId

public void setStoreId(java.lang.Integer newStoreId)

This method sets the ID of the store to which this experiment belongs.

Parameters:

newStoreId - The ID of the store to which this experiment belongs.