CampaignInitiative

java.lang.Object
- com.ibm.commerce.experimentation.runtime.DynamicEntity
- - com.ibm.commerce.experimentation.runtime.CampaignInitiative

All Implemented Interfaces:

java.io.Serializable
```
public class CampaignInitiative
extends DynamicEntity
implements java.io.Serializable
```
This class extends com.ibm.commerce.experimentation.runtime.DynamicEntity to provide a custom implementation of managing the required fields for a Campaign Activity.

See Also:

Serialized Form

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
`CampaignInitiative()` The default constructor for this class.
`CampaignInitiative(java.lang.Integer newObjectId, java.lang.Integer newInitiativeId, java.lang.String newInitiativeName, Rule newRule, java.lang.Integer newCampaignId, java.lang.String newCampaignName, java.lang.String newResultType, java.lang.Integer newScheduleId, java.lang.Integer newSchedulePriority, java.lang.String newStatus, java.lang.Integer newStoreId)` Constructor with data to construct this object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getCampaignId()` This method returns the ID of the associated campaign.
`java.lang.String`	`getCampaignName()` This method returns the name of the associated campaign.
`java.lang.Integer`	`getInitiativeId()` This method returns the campaign activity ID.
`java.lang.String`	`getInitiativeName()` This method returns the campaign activity name.
`java.lang.Integer`	`getObjectId()` This method returns the ID that uniquely identifies this object.
`java.lang.Integer`	`getPromotionId()` This method returns the ID of the promotion that is associated with this campaign activity.
`java.lang.String`	`getPromotionName()` This method returns the name of the promotion that is associated with this campaign activity.
`java.lang.String`	`getResultType()` This method returns the campaign activity result type.
`Rule`	`getRule()` This method returns the campaign activity rule XML represented by the `com.ibm.commerce.rule.Rule` class.
`java.lang.Integer`	`getScheduleId()` This method returns the campaign activity schedule ID.
`java.lang.Integer`	`getSchedulePriority()` This method returns the campaign activity schedule priority.
`java.lang.String`	`getStatus()` This method returns the campaign activity status.
`java.lang.Integer`	`getStoreId()` This method returns the ID of the store to which this campaign activity belongs.
`void`	`setCampaignId(java.lang.Integer newCampaignId)` This method sets the ID of the associated campaign.
`void`	`setCampaignName(java.lang.String newCampaignName)` This method sets the name of the associated campaign.
`void`	`setInitiativeId(java.lang.Integer newInitiativeId)` This method sets the campaign activity ID.
`void`	`setInitiativeName(java.lang.String newInitiativeName)` This method sets the campaign activity name.
`void`	`setObjectId(java.lang.Integer newObjectId)` This method sets the ID that uniquely identifies this object.
`void`	`setResultType(java.lang.String newResultType)` This method sets the campaign activity result type.
`void`	`setRule(Rule newRule)` This method sets the campaign activity rule XML represented by the `com.ibm.commerce.rule.Rule` class.
`void`	`setScheduleId(java.lang.Integer newScheduleId)` This method sets the campaign activity schedule ID.
`void`	`setSchedulePriority(java.lang.Integer newSchedulePriority)` This method sets the campaign activity schedule priority.
`void`	`setStatus(java.lang.String newStatus)` This method sets the campaign activity status.
`void`	`setStoreId(java.lang.Integer newStoreId)` This method sets the ID of the store to which this campaign activity belongs.

Methods inherited from class com.ibm.commerce.experimentation.runtime.DynamicEntity
getControlElementViewed, getEntityExperimental, getExperimentId, getExperimentName, getStoreElementTypeId, getViewedElementId, getViewedElementName, getViewedElementRatio, setControlElementViewed, setEntityExperimental, setExperimentId, setExperimentName, setStoreElementTypeId, setViewedElementId, setViewedElementName, setViewedElementRatio

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
  - CampaignInitiative
```
public CampaignInitiative()
```
    The default constructor for this class. All of the fields are instantiated as a null value.
  - CampaignInitiative
```
public CampaignInitiative(java.lang.Integer newObjectId,
                          java.lang.Integer newInitiativeId,
                          java.lang.String newInitiativeName,
                          Rule newRule,
                          java.lang.Integer newCampaignId,
                          java.lang.String newCampaignName,
                          java.lang.String newResultType,
                          java.lang.Integer newScheduleId,
                          java.lang.Integer newSchedulePriority,
                          java.lang.String newStatus,
                          java.lang.Integer newStoreId)
```
    Constructor with data to construct this object.
    
    Parameters:
    
    newObjectId - The ID that uniquely identifies this object.
    
    newInitiativeId - The campaign activity ID.
    
    newInitiativeName - The campaign activity name.
    
    newRule - The campaign activity rule XML represented by the com.ibm.commerce.rule.Rule class.
    
    newCampaignId - The ID of the associated campaign.
    
    newCampaignName - The name of the associated campaign.
    
    newResultType - The campaign activity result type.
    
    newScheduleId - The campaign activity schedule ID.
    
    newSchedulePriority - The campaign activity schedule priority.
    
    newStatus - The campaign activity status.
    
    newStoreId - The ID of the store to which this campaign activity belongs.
- Method Detail
  - getCampaignId
```
public java.lang.Integer getCampaignId()
```
    This method returns the ID of the associated campaign.
    
    Returns:
    
    The ID of the associated campaign.
  - getCampaignName
```
public java.lang.String getCampaignName()
```
    This method returns the name of the associated campaign.
    
    Returns:
    
    The name of the associated campaign.
  - getInitiativeId
```
public java.lang.Integer getInitiativeId()
```
    This method returns the campaign activity ID.
    
    Returns:
    
    The campaign activity ID.
  - getInitiativeName
```
public java.lang.String getInitiativeName()
```
    This method returns the campaign activity name.
    
    Returns:
    
    The campaign activity name.
  - getObjectId
```
public java.lang.Integer getObjectId()
```
    This method returns the ID that uniquely identifies this object.
    
    Returns:
    
    The unique ID of this object.
  - getPromotionId
```
public java.lang.Integer getPromotionId()
```
    This method returns the ID of the promotion that is associated with this campaign activity.
    
    Returns:
    
    The promotion ID.
  - getPromotionName
```
public java.lang.String getPromotionName()
```
    This method returns the name of the promotion that is associated with this campaign activity.
    
    Returns:
    
    The promotion name.
  - getResultType
```
public java.lang.String getResultType()
```
    This method returns the campaign activity result type.
    
    Returns:
    
    The campaign activity result type.
  - getRule
```
public Rule getRule()
```
    This method returns the campaign activity rule XML represented by the com.ibm.commerce.rule.Rule class.
    
    Returns:
    
    The campaign activity rule XML represented by the com.ibm.commerce.rule.Rule class.
  - getScheduleId
```
public java.lang.Integer getScheduleId()
```
    This method returns the campaign activity schedule ID.
    
    Returns:
    
    The campaign activity schedule ID.
  - getSchedulePriority
```
public java.lang.Integer getSchedulePriority()
```
    This method returns the campaign activity schedule priority.
    
    Returns:
    
    The campaign activity schedule priority.
  - getStatus
```
public java.lang.String getStatus()
```
    This method returns the campaign activity status.
    
    Returns:
    
    The campaign activity status.
  - getStoreId
```
public java.lang.Integer getStoreId()
```
    This method returns the ID of the store to which this campaign activity belongs.
    
    Returns:
    
    The ID of the store to which this campaign activity belongs.
  - setCampaignId
```
public void setCampaignId(java.lang.Integer newCampaignId)
```
    This method sets the ID of the associated campaign.
    
    Parameters:
    
    newCampaignId - The ID of the associated campaign.
  - setCampaignName
```
public void setCampaignName(java.lang.String newCampaignName)
```
    This method sets the name of the associated campaign.
    
    Parameters:
    
    newCampaignName - The name of the associated campaign.
  - setInitiativeId
```
public void setInitiativeId(java.lang.Integer newInitiativeId)
```
    This method sets the campaign activity ID.
    
    Parameters:
    
    newInitiativeId - The campaign activity ID.
  - setInitiativeName
```
public void setInitiativeName(java.lang.String newInitiativeName)
```
    This method sets the campaign activity name.
    
    Parameters:
    
    newInitiativeName - The campaign activity name.
  - setObjectId
```
public void setObjectId(java.lang.Integer newObjectId)
```
    This method sets the ID that uniquely identifies this object.
    
    Parameters:
    
    newObjectId - The unique ID of this object.
  - setResultType
```
public void setResultType(java.lang.String newResultType)
```
    This method sets the campaign activity result type.
    
    Parameters:
    
    newResultType - The campaign activity result type.
  - setRule
```
public void setRule(Rule newRule)
```
    This method sets the campaign activity rule XML represented by the com.ibm.commerce.rule.Rule class.
    
    Parameters:
    
    newRule - The campaign activity rule XML represented by the com.ibm.commerce.rule.Rule class.
  - setScheduleId
```
public void setScheduleId(java.lang.Integer newScheduleId)
```
    This method sets the campaign activity schedule ID.
    
    Parameters:
    
    newScheduleId - The campaign activity schedule ID.
  - setSchedulePriority
```
public void setSchedulePriority(java.lang.Integer newSchedulePriority)
```
    This method sets the campaign activity schedule priority.
    
    Parameters:
    
    newSchedulePriority - The campaign activity schedule priority.
  - setStatus
```
public void setStatus(java.lang.String newStatus)
```
    This method sets the campaign activity status.
    
    Parameters:
    
    newStatus - The campaign activity status.
  - setStoreId
```
public void setStoreId(java.lang.Integer newStoreId)
```
    This method sets the ID of the store to which this campaign activity belongs.
    
    Parameters:
    
    newStoreId - The ID of the store to which this campaign activity belongs.

Methods inherited from class com.ibm.commerce.experimentation.runtime.DynamicEntity

Methods inherited from class java.lang.Object

COPYRIGHT

CampaignInitiative

CampaignInitiative

getCampaignId

getCampaignName

getInitiativeId

getInitiativeName

getObjectId

getPromotionId

getPromotionName

getResultType

getRule

getScheduleId

getSchedulePriority

getStatus

getStoreId

setCampaignId

setCampaignName

setInitiativeId

setInitiativeName

setObjectId

setResultType

setRule

setScheduleId

setSchedulePriority

setStatus

setStoreId