ExperimentRuleDefinition

java.lang.Object
- com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition

```
public abstract class ExperimentRuleDefinition
extends java.lang.Object
```
This class represents the rule definition for an experiment. It provides methods to populate this object from an XML representation of the rule definition, and to convert the rule definition into an XML document.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

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

Constructor Summary

Constructors
Constructor and Description

ExperimentRuleDefinition()

Constructors
Constructor and Description
`ExperimentRuleDefinition()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.String`	`convertToXml()` Converts a specific rule definition object into an XML document.
`java.lang.Integer`	`getControlElementId()` This method returns the internal ID of the control element defined in this experiment rule.
`DynamicKey`	`getControlElementKey()` This method returns the key object of the control element defined in this experiment rule.
`java.lang.String`	`getControlElementName()` This method returns the name of the control element defined in this experiment rule.
`java.lang.Integer`	`getControlElementRatio()` This method returns the ratio of the control element defined in this experiment rule.
`java.lang.String`	`getControlElementType()` This method returns the type of the control element defined in this experiment rule.
`java.lang.String`	`getExperimentType()` This method returns the type of this experiment.
`java.lang.Integer`	`getLanguageId()` This method returns the ID of language being set in this object.
`java.util.Locale`	`getLocale()` This method returns the locale to be used in this class.
`DynamicKey`	`getStoreElementKey()` This method returns the key object of the store element defined in this experiment rule.
`java.lang.String`	`getStoreElementName()` This method returns the name of the store element defined in this experiment rule.
`java.lang.String`	`getStoreElementType()` This method returns the type of the store element defined in this experiment rule.
`java.util.Vector`	`getTestElementId()` This method returns the internal ID of all test elements defined in this experiment rule.
`java.lang.Integer`	`getTestElementIdCounter()` This method returns the current ID of the last test element in the array defined in this experiment rule.
`java.util.Vector`	`getTestElementKey()` This method returns the key object of all test elements defined in this experiment rule.
`java.util.Vector`	`getTestElementName()` This method returns the name of all test elements defined in this experiment rule.
`java.util.Vector`	`getTestElementRatio()` This method returns the ratio of all test elements defined in this experiment rule.
`java.util.Vector`	`getTestElementType()` This method returns the type of all test elements defined in this experiment rule.
`abstract void`	`populateFromRuleHashtable(java.util.Hashtable ruleHashtable)` Populates a specific rule definition object from hashtable representation of the rule.
`abstract void`	`populateFromRuleXml(java.lang.String ruleXml)` Populates a specific rule definition object from an XML representation of the rule.
`void`	`setControlElementId(java.lang.Integer newControlElementId)` This method sets the internal ID of the control element defined in this experiment rule.
`void`	`setControlElementKey(DynamicKey newControlElementKey)` This method sets the key object of the control element defined in this experiment rule.
`void`	`setControlElementName(java.lang.String newControlElementName)` This method sets the name of the control element defined in this experiment rule.
`void`	`setControlElementRatio(java.lang.Integer newControlElementRatio)` This method sets the ratio of the control element defined in this experiment rule.
`void`	`setControlElementType(java.lang.String newControlElementType)` This method sets the type of the control element defined in this experiment rule.
`void`	`setExperimentType(java.lang.String newExperimentType)` This method sets the type of this experiment.
`void`	`setLanguageId(java.lang.Integer newLanguageId)` This method sets the ID of language.
`void`	`setLocale(java.util.Locale newLocale)` This method sets the locale to be used in this class.
`void`	`setStoreElementKey(DynamicKey newStoreElementKey)` This method sets the key object of the store element defined in this experiment rule.
`void`	`setStoreElementName(java.lang.String newStoreElementName)` This method sets the name of the store element defined in this experiment rule.
`void`	`setStoreElementType(java.lang.String newStoreElementType)` This method sets the type of the store element defined in this experiment rule.
`void`	`setTestElementId(java.util.Vector newTestElementId)` This method sets the internal ID of all test elements defined in this experiment rule.
`void`	`setTestElementIdCounter(java.lang.Integer newTestElementIdCounter)` This method sets the current ID of the last test element in the array defined in this experiment rule.
`void`	`setTestElementKey(java.util.Vector newTestElementKey)` This method sets the key object of all test elements defined in this experiment rule.
`void`	`setTestElementName(java.util.Vector newTestElementName)` This method sets the name of all test elements defined in this experiment rule.
`void`	`setTestElementRatio(java.util.Vector newTestElementRatio)` This method sets the ratio of all test elements defined in this experiment rule.
`void`	`setTestElementType(java.util.Vector newTestElementType)` This method sets the type of all test elements defined in this experiment rule.

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
  - ExperimentRuleDefinition
```
public ExperimentRuleDefinition()
```
- Method Detail
  - convertToXml
```
public abstract java.lang.String convertToXml()
```
    Converts a specific rule definition object into an XML document.
    
    Returns:
    
    The XML representation of the rule.
  - populateFromRuleHashtable
```
public abstract void populateFromRuleHashtable(java.util.Hashtable ruleHashtable)
```
    Populates a specific rule definition object from hashtable representation of the rule.
    
    Parameters:
    
    ruleHashtable - The hashtable representation of the rule.
  - populateFromRuleXml
```
public abstract void populateFromRuleXml(java.lang.String ruleXml)
```
    Populates a specific rule definition object from an XML representation of the rule.
    
    Parameters:
    
    ruleXml - The XML representation of the rule.
  - getControlElementId
```
public java.lang.Integer getControlElementId()
```
    This method returns the internal ID of the control element defined in this experiment rule.
    
    Returns:
    
    The internal ID of the control element.
  - getControlElementKey
```
public DynamicKey getControlElementKey()
```
    This method returns the key object of the control element defined in this experiment rule.
    
    Returns:
    
    The internal Key object of the control element.
  - getControlElementName
```
public java.lang.String getControlElementName()
```
    This method returns the name of the control element defined in this experiment rule.
    
    Returns:
    
    The name of the control element.
  - getControlElementRatio
```
public java.lang.Integer getControlElementRatio()
```
    This method returns the ratio of the control element defined in this experiment rule.
    
    Returns:
    
    The ratio of the control element.
  - getControlElementType
```
public java.lang.String getControlElementType()
```
    This method returns the type of the control element defined in this experiment rule.
    
    Returns:
    
    The type of the control element.
  - getExperimentType
```
public java.lang.String getExperimentType()
```
    This method returns the type of this experiment.
    
    Returns:
    
    The type of the experiment.
  - getLanguageId
```
public java.lang.Integer getLanguageId()
```
    This method returns the ID of language being set in this object.
    
    Returns:
    
    The language ID.
  - getLocale
```
public java.util.Locale getLocale()
```
    This method returns the locale to be used in this class.
    
    Returns:
    
    The locale object.
  - getStoreElementKey
```
public DynamicKey getStoreElementKey()
```
    This method returns the key object of the store element defined in this experiment rule.
    
    Returns:
    
    The internal Key object of the store element.
  - getStoreElementName
```
public java.lang.String getStoreElementName()
```
    This method returns the name of the store element defined in this experiment rule.
    
    Returns:
    
    The name of the store element.
  - getStoreElementType
```
public java.lang.String getStoreElementType()
```
    This method returns the type of the store element defined in this experiment rule.
    
    Returns:
    
    The type of the store element.
  - getTestElementIdCounter
```
public java.lang.Integer getTestElementIdCounter()
```
    This method returns the current ID of the last test element in the array defined in this experiment rule.
    
    Returns:
    
    The internal IDs of all test elements.
  - getTestElementId
```
public java.util.Vector getTestElementId()
```
    This method returns the internal ID of all test elements defined in this experiment rule.
    
    Returns:
    
    The internal IDs of all test elements.
  - getTestElementKey
```
public java.util.Vector getTestElementKey()
```
    This method returns the key object of all test elements defined in this experiment rule.
    
    Returns:
    
    The internal Key objects of all test elements.
  - getTestElementName
```
public java.util.Vector getTestElementName()
```
    This method returns the name of all test elements defined in this experiment rule.
    
    Returns:
    
    The names of all test elements.
  - getTestElementRatio
```
public java.util.Vector getTestElementRatio()
```
    This method returns the ratio of all test elements defined in this experiment rule.
    
    Returns:
    
    The ratios of all test elements.
  - getTestElementType
```
public java.util.Vector getTestElementType()
```
    This method returns the type of all test elements defined in this experiment rule.
    
    Returns:
    
    The types of all test elements.
  - setControlElementId
```
public void setControlElementId(java.lang.Integer newControlElementId)
```
    This method sets the internal ID of the control element defined in this experiment rule.
    
    Parameters:
    
    newControlElementId - The internal ID of the control element.
  - setControlElementKey
```
public void setControlElementKey(DynamicKey newControlElementKey)
```
    This method sets the key object of the control element defined in this experiment rule.
    
    Parameters:
    
    newControlElementKey - The internal Key object of the control element.
  - setControlElementName
```
public void setControlElementName(java.lang.String newControlElementName)
```
    This method sets the name of the control element defined in this experiment rule.
    
    Parameters:
    
    newControlElementName - The name of the control element.
  - setControlElementRatio
```
public void setControlElementRatio(java.lang.Integer newControlElementRatio)
```
    This method sets the ratio of the control element defined in this experiment rule.
    
    Parameters:
    
    newControlElementRatio - The ratio of the control element.
  - setControlElementType
```
public void setControlElementType(java.lang.String newControlElementType)
```
    This method sets the type of the control element defined in this experiment rule.
    
    Parameters:
    
    newControlElementType - The type of the control element.
  - setExperimentType
```
public void setExperimentType(java.lang.String newExperimentType)
```
    This method sets the type of this experiment.
    
    Parameters:
    
    newExperimentType - The type of the experiment.
  - setLanguageId
```
public void setLanguageId(java.lang.Integer newLanguageId)
```
    This method sets the ID of language.
    
    Parameters:
    
    newLanguageId - The language ID.
  - setLocale
```
public void setLocale(java.util.Locale newLocale)
```
    This method sets the locale to be used in this class.
    
    Parameters:
    
    newLocale - The locale object.
  - setStoreElementKey
```
public void setStoreElementKey(DynamicKey newStoreElementKey)
```
    This method sets the key object of the store element defined in this experiment rule.
    
    Parameters:
    
    newStoreElementKey - The internal Key object of the store element.
  - setStoreElementName
```
public void setStoreElementName(java.lang.String newStoreElementName)
```
    This method sets the name of the store element defined in this experiment rule.
    
    Parameters:
    
    newStoreElementName - The name of the store element.
  - setStoreElementType
```
public void setStoreElementType(java.lang.String newStoreElementType)
```
    This method sets the type of the store element defined in this experiment rule.
    
    Parameters:
    
    newStoreElementType - The type of the store element.
  - setTestElementIdCounter
```
public void setTestElementIdCounter(java.lang.Integer newTestElementIdCounter)
```
    This method sets the current ID of the last test element in the array defined in this experiment rule.
    
    Parameters:
    
    newTestElementIdCounter - The current ID of the last test element in the array.
  - setTestElementId
```
public void setTestElementId(java.util.Vector newTestElementId)
```
    This method sets the internal ID of all test elements defined in this experiment rule.
    
    Parameters:
    
    newTestElementId - The internal IDs of all test elements.
  - setTestElementKey
```
public void setTestElementKey(java.util.Vector newTestElementKey)
```
    This method sets the key object of all test elements defined in this experiment rule.
    
    Parameters:
    
    newTestElementKey - The internal Key objects of all test elements.
  - setTestElementName
```
public void setTestElementName(java.util.Vector newTestElementName)
```
    This method sets the name of all test elements defined in this experiment rule.
    
    Parameters:
    
    newTestElementName - The names of all test elements.
  - setTestElementRatio
```
public void setTestElementRatio(java.util.Vector newTestElementRatio)
```
    This method sets the ratio of all test elements defined in this experiment rule.
    
    Parameters:
    
    newTestElementRatio - The ratios of all test elements.
  - setTestElementType
```
public void setTestElementType(java.util.Vector newTestElementType)
```
    This method sets the type of all test elements defined in this experiment rule.
    
    Parameters:
    
    newTestElementType - The types of all test elements.

Methods inherited from class java.lang.Object

COPYRIGHT

ExperimentRuleDefinition

convertToXml

populateFromRuleHashtable

populateFromRuleXml

getControlElementId

getControlElementKey

getControlElementName

getControlElementRatio

getControlElementType

getExperimentType

getLanguageId

getLocale

getStoreElementKey

getStoreElementName

getStoreElementType

getTestElementIdCounter

getTestElementId

getTestElementKey

getTestElementName

getTestElementRatio

getTestElementType

setControlElementId

setControlElementKey

setControlElementName

setControlElementRatio

setControlElementType

setExperimentType

setLanguageId

setLocale

setStoreElementKey

setStoreElementName

setStoreElementType

setTestElementIdCounter

setTestElementId

setTestElementKey

setTestElementName

setTestElementRatio

setTestElementType