com.ibm.commerce.tools.campaigns
Class CampaignInitiativeDetailsDataBean

com.ibm.commerce.tools.campaigns.CampaignInitiativeDetailsDataBean
All Implemented Interfaces:
ConditionConstants

public class CampaignInitiativeDetailsDataBean
implements ConditionConstants

The CampaignInitiativeDetailsDataBean class extends the CampaignInitiativeDataBean class to create a detailed databean for a campaign initiative.


Inner Class Summary
static class CampaignInitiativeDetailsDataBean.WhenChoice
          The WhenChoice inner class defines the WHICH condition of the campaign initiative.
 
Field Summary
protected  java.util.Vector _availableCollateral
          Campaign initiative WHAT condition available general ad copies.
protected  java.util.Vector _availableCouponCollateral
          Campaign initiative WHAT condition available coupon advertisement.
protected  java.util.Vector _availableDiscountCollateral
          Campaign initiative WHAT condition available discount advertisement.
protected  java.util.Vector _availableSegments
          Campaign initiative available segments.
protected  java.lang.String _categoryLanguageDescription
          Campaign initiative WHAT condition language description for category.
protected  java.lang.String _currency
          Campaign initiative currency to use in the condition.
protected  java.util.Vector _daysOfTheWeek
          Campaign initiative WHEN condition selected days of the week.
protected  boolean _everyday
          Campaign initiative WHEN condition everyday flag.
protected  java.lang.Integer _languageId
          Campaign initiative language to use in the condition.
protected  java.util.Vector _productAttributes
          Campaign initiative WHAT condition product attributes.
protected  java.lang.String _productLanguageDescription
          Campaign initiative WHAT condition language description for product.
protected  java.util.Vector _productSkus
          Campaign initiative WHAT condition selected product SKU.
protected  java.util.Vector _selectedCategories
          Campaign initiative WHAT condition selected categories.
protected  java.util.Vector _selectedCollateral
          Campaign initiative WHAT condition selected general ad copies.
protected  java.util.Vector _selectedCouponCollateral
          Campaign initiative WHAT condition selected coupon advertisement.
protected  java.lang.String _selectedDiscountCode
          Campaign initiative WHAT condition selected discount advertisement code.
protected  java.util.Vector _selectedDiscountCollateral
          Campaign initiative WHAT condition selected discount advertisement.
protected  java.lang.String _selectedDiscountUsage
          Campaign initiative WHAT condition selected discount advertisement details.
protected  java.util.Vector _selectedSegments
          Campaign initiative selected segments.
protected  boolean _targetAllShoppers
          Campaign initiative target all shoppers flag.
protected  java.lang.String _whatType
          Campaign initiative WHAT type.
protected  java.util.Vector _whenChoices
          Campaign initiative WHEN conditions.
static java.lang.String COPYRIGHT
          Copyright.
 
Fields inherited from interface com.ibm.commerce.condition.ConditionConstants
AND_LIST_CONDITION, OPEN_CONDITION, OPERATOR_CONTAINS, OPERATOR_DOES_NOT_CONTAIN, OPERATOR_DOES_NOT_END_WITH, OPERATOR_DOES_NOT_START_WITH, OPERATOR_ENDS_WITH, OPERATOR_EQUAL_TO, OPERATOR_GREATER_THAN, OPERATOR_GREATER_THAN_OR_EQUAL_TO, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL_TO, OPERATOR_NOT_EQUAL_TO, OPERATOR_STARTS_WITH, OR_LIST_CONDITION, SIMPLE_CONDITION, TRUE_CONDITION, XML_DTD_FRAGMENT, XML_INDENT
 
Constructor Summary
CampaignInitiativeDetailsDataBean()
           
 
Method Summary
 java.util.Vector getAvailableCollateral()
          Gets the campaign initiative available general ad copies.
 java.util.Vector getAvailableCouponCollateral()
          Gets the campaign initiative available coupon ad copies.
 java.util.Vector getAvailableDiscountCollateral()
          Gets the campaign initiative available discount ad copies.
 java.util.Vector getAvailableSegments()
          Gets the campaign initiative available segments.
 java.lang.Integer getCampaignId()
          Gets the campaign ID of the initiative.
 java.lang.String getCampaignName()
          Gets the campaign name of the initiative.
 java.lang.String getCategoryLanguageDescription()
          Gets the campaign initiative category language description.
 java.lang.String getCurrency()
          Gets the currency used in this campaign initiative.
 java.util.Vector getDaysOfTheWeek()
          Gets the days of the week used in this campaign initiative WHEN condition.
 java.lang.String getDescription()
          Gets the campaign initiative description.
 boolean getDisabled()
          Gets the campaign initiative disable flag.
 boolean getEveryday()
          Gets the everyday flag used in this campaign initiative WHEN condition.
 java.lang.Integer getId()
          Gets the campaign initiative ID.
 java.lang.String getInitiativeName()
          Gets the campaign initiative name.
 java.lang.Integer getLanguageId()
          Gets the language ID used in this campaign initiative.
 java.lang.Long getLastUpdateDate()
          Gets the campaign initiative last updated date.
 java.lang.String getLastUpdatedBy()
          Gets the campaign initiative last updated user.
 java.util.Vector getProductAttributes()
          Gets the product attributes used in this campaign initiative WHAT condition.
 java.lang.String getProductLanguageDescription()
          Gets the description of the product language used in this campaign initiative WHAT condition.
 java.util.Vector getProductSkus()
          Gets the product SKUs used in this campaign initiative WHAT condition.
 java.util.Vector getSelectedCategories()
          Gets the selected categories in this campaign initiative WHAT condition.
 java.util.Vector getSelectedCollateral()
          Gets the selected campaign initiative general ad copies.
 java.util.Vector getSelectedCouponCollateral()
          Gets the selected campaign initiative coupon ad copies.
 java.lang.String getSelectedDiscountCode()
          Gets the code of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
 java.util.Vector getSelectedDiscountCollateral()
          Gets the selected campaign initiative discount ad copies.
 java.lang.String getSelectedDiscountUsage()
          Gets the details of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
 java.util.Vector getSelectedSegments()
          Gets the selected segments in this campaign initiative WHO condition.
 java.lang.Integer getSellType()
          Gets the campaign initiative sell type.
 boolean getTargetAllShoppers()
          Gets the target all shoppers flag used in the campaign initiative WHO condition.
 java.lang.String getWhatType()
          Gets the type of the campaign initiative WHAT condition.
 java.util.Vector getWhenChoices()
          Gets the choices of the campaign initiative WHICH condition.
 void populate()
          Populate the databean.
protected  void populateCollateral()
          Populate all the selected and available collateral of this initiative.
protected  void populateCondition(Condition condition)
          Populate the details of the condition.
protected  void populateCouponCollateral()
          Populate the selected and available coupon collateral of this initiative.
protected  void populateDiscountCollateral()
          Populate the selected and available discount collateral of this initiative.
protected  void populateGeneralCollateral()
          Populate the selected and available general collateral of this initiative.
protected  void populateOpenCondition(OpenCondition condition)
          Populate the details of the open condition.
protected  void populateRule()
          Populate the details of the initiative business rule.
protected  void populateSegments()
          Populate the selected segments of this campaign initiative.
protected  void populateSimpleCondition(SimpleCondition condition)
          Populate the details of the simple condition.
 void setCategoryLanguageDescription(java.lang.String newCategoryLanguageDescription)
          Sets the campaign initiative category language description.
 void setProductLanguageDescription(java.lang.String newProductLanguageDescription)
          Sets the campaign initiative product language description.
 void setXML(java.util.Hashtable xml)
          Sets the XML.
 

Field Detail

_availableCollateral

protected java.util.Vector _availableCollateral
Campaign initiative WHAT condition available general ad copies.

_availableCouponCollateral

protected java.util.Vector _availableCouponCollateral
Campaign initiative WHAT condition available coupon advertisement.

_availableDiscountCollateral

protected java.util.Vector _availableDiscountCollateral
Campaign initiative WHAT condition available discount advertisement.

_availableSegments

protected java.util.Vector _availableSegments
Campaign initiative available segments.

_categoryLanguageDescription

protected java.lang.String _categoryLanguageDescription
Campaign initiative WHAT condition language description for category.

_currency

protected java.lang.String _currency
Campaign initiative currency to use in the condition.

_daysOfTheWeek

protected java.util.Vector _daysOfTheWeek
Campaign initiative WHEN condition selected days of the week.

_everyday

protected boolean _everyday
Campaign initiative WHEN condition everyday flag.

_languageId

protected java.lang.Integer _languageId
Campaign initiative language to use in the condition.

_productAttributes

protected java.util.Vector _productAttributes
Campaign initiative WHAT condition product attributes.

_productLanguageDescription

protected java.lang.String _productLanguageDescription
Campaign initiative WHAT condition language description for product.

_productSkus

protected java.util.Vector _productSkus
Campaign initiative WHAT condition selected product SKU.

_selectedCategories

protected java.util.Vector _selectedCategories
Campaign initiative WHAT condition selected categories.

_selectedCollateral

protected java.util.Vector _selectedCollateral
Campaign initiative WHAT condition selected general ad copies.

_selectedCouponCollateral

protected java.util.Vector _selectedCouponCollateral
Campaign initiative WHAT condition selected coupon advertisement.

_selectedDiscountCode

protected java.lang.String _selectedDiscountCode
Campaign initiative WHAT condition selected discount advertisement code.

_selectedDiscountCollateral

protected java.util.Vector _selectedDiscountCollateral
Campaign initiative WHAT condition selected discount advertisement.

_selectedDiscountUsage

protected java.lang.String _selectedDiscountUsage
Campaign initiative WHAT condition selected discount advertisement details.

_selectedSegments

protected java.util.Vector _selectedSegments
Campaign initiative selected segments.

_targetAllShoppers

protected boolean _targetAllShoppers
Campaign initiative target all shoppers flag.

_whatType

protected java.lang.String _whatType
Campaign initiative WHAT type.

_whenChoices

protected java.util.Vector _whenChoices
Campaign initiative WHEN conditions.

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.
Constructor Detail

CampaignInitiativeDetailsDataBean

public CampaignInitiativeDetailsDataBean()
Method Detail

getAvailableCollateral

public java.util.Vector getAvailableCollateral()
Gets the campaign initiative available general ad copies.
Returns:
The campaign initiative available general ad copies.

getAvailableCouponCollateral

public java.util.Vector getAvailableCouponCollateral()
Gets the campaign initiative available coupon ad copies.
Returns:
The campaign initiative available coupon ad copies.

getAvailableDiscountCollateral

public java.util.Vector getAvailableDiscountCollateral()
Gets the campaign initiative available discount ad copies.
Returns:
The campaign initiative available discount ad copies.

getAvailableSegments

public java.util.Vector getAvailableSegments()
Gets the campaign initiative available segments.
Returns:
The campaign initiative available segments.

getCampaignId

public java.lang.Integer getCampaignId()
Gets the campaign ID of the initiative.
Returns:
The campaign ID of the initiative.

getCampaignName

public java.lang.String getCampaignName()
Gets the campaign name of the initiative.
Returns:
The campaign name of the initiative.

getCategoryLanguageDescription

public java.lang.String getCategoryLanguageDescription()
Gets the campaign initiative category language description.
Returns:
The campaign initiative category language description.

getCurrency

public java.lang.String getCurrency()
Gets the currency used in this campaign initiative.
Returns:
The currency used in this campaign initiative.

getDaysOfTheWeek

public java.util.Vector getDaysOfTheWeek()
Gets the days of the week used in this campaign initiative WHEN condition.
Returns:
The days of the week used in this campaign initiative WHEN condition.

getDescription

public java.lang.String getDescription()
Gets the campaign initiative description.
Returns:
The campaign initiative description.

getDisabled

public boolean getDisabled()
Gets the campaign initiative disable flag.
Returns:
The campaign initiative disable flag.

getEveryday

public boolean getEveryday()
Gets the everyday flag used in this campaign initiative WHEN condition.
Returns:
The everyday flag used in this campaign initiative WHEN condition.

getId

public java.lang.Integer getId()
Gets the campaign initiative ID.
Returns:
The campaign initiative ID.

getInitiativeName

public java.lang.String getInitiativeName()
Gets the campaign initiative name.
Returns:
The campaign initiative name.

getLanguageId

public java.lang.Integer getLanguageId()
Gets the language ID used in this campaign initiative.
Returns:
The language ID used in this campaign initiative.

getLastUpdateDate

public java.lang.Long getLastUpdateDate()
Gets the campaign initiative last updated date.
Returns:
The campaign initiative last updated date.

getLastUpdatedBy

public java.lang.String getLastUpdatedBy()
Gets the campaign initiative last updated user.
Returns:
The campaign initiative last updated user.

getProductAttributes

public java.util.Vector getProductAttributes()
Gets the product attributes used in this campaign initiative WHAT condition.
Returns:
The product attributes used in this campaign initiative WHAT condition.

getProductLanguageDescription

public java.lang.String getProductLanguageDescription()
Gets the description of the product language used in this campaign initiative WHAT condition.
Returns:
The description of the product language used in this campaign initiative WHAT condition.

getProductSkus

public java.util.Vector getProductSkus()
Gets the product SKUs used in this campaign initiative WHAT condition.
Returns:
The product SKUs used in this campaign initiative WHAT condition.

getSelectedCategories

public java.util.Vector getSelectedCategories()
Gets the selected categories in this campaign initiative WHAT condition.
Returns:
The selected categories in this campaign initiative WHAT condition.

getSelectedCollateral

public java.util.Vector getSelectedCollateral()
Gets the selected campaign initiative general ad copies.
Returns:
The selected campaign initiative general ad copies.

getSelectedCouponCollateral

public java.util.Vector getSelectedCouponCollateral()
Gets the selected campaign initiative coupon ad copies.
Returns:
The selected campaign initiative coupon ad copies.

getSelectedDiscountCode

public java.lang.String getSelectedDiscountCode()
Gets the code of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
Returns:
The code of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.

getSelectedDiscountCollateral

public java.util.Vector getSelectedDiscountCollateral()
Gets the selected campaign initiative discount ad copies.
Returns:
The selected campaign initiative discount ad copies.

getSelectedDiscountUsage

public java.lang.String getSelectedDiscountUsage()
Gets the details of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
Returns:
The details of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.

getSelectedSegments

public java.util.Vector getSelectedSegments()
Gets the selected segments in this campaign initiative WHO condition.
Returns:
The selected segments in this campaign initiative WHO condition.

getSellType

public java.lang.Integer getSellType()
Gets the campaign initiative sell type.
Returns:
The campaign initiative sell type.

getTargetAllShoppers

public boolean getTargetAllShoppers()
Gets the target all shoppers flag used in the campaign initiative WHO condition.
Returns:
The target all shoppers flag used in the campaign initiative WHO condition.

getWhatType

public java.lang.String getWhatType()
Gets the type of the campaign initiative WHAT condition.
Returns:
The type of the campaign initiative WHAT condition.

getWhenChoices

public java.util.Vector getWhenChoices()
Gets the choices of the campaign initiative WHICH condition.
Returns:
The choices of the campaign initiative WHICH condition.

populate

public void populate()
              throws java.lang.Exception
Populate the databean.

populateCollateral

protected void populateCollateral()
Populate all the selected and available collateral of this initiative.

populateCondition

protected void populateCondition(Condition condition)
Populate the details of the condition.
Parameters:
condition - Condition definition.

populateCouponCollateral

protected void populateCouponCollateral()
Populate the selected and available coupon collateral of this initiative.

populateDiscountCollateral

protected void populateDiscountCollateral()
Populate the selected and available discount collateral of this initiative.

populateGeneralCollateral

protected void populateGeneralCollateral()
Populate the selected and available general collateral of this initiative.

populateOpenCondition

protected void populateOpenCondition(OpenCondition condition)
Populate the details of the open condition.
Parameters:
condition - Open condition definition.

populateRule

protected void populateRule()
Populate the details of the initiative business rule.

populateSegments

protected void populateSegments()
Populate the selected segments of this campaign initiative.

populateSimpleCondition

protected void populateSimpleCondition(SimpleCondition condition)
Populate the details of the simple condition.
Parameters:
condition - Simple condition definition.

setCategoryLanguageDescription

public void setCategoryLanguageDescription(java.lang.String newCategoryLanguageDescription)
Sets the campaign initiative category language description.
Parameters:
newCategoryLanguageDescription - The campaign category language description.

setProductLanguageDescription

public void setProductLanguageDescription(java.lang.String newProductLanguageDescription)
Sets the campaign initiative product language description.
Parameters:
newProductLanguageDescription - The campaign product language description.

setXML

public void setXML(java.util.Hashtable xml)
Sets the XML.
Parameters:
xml - The xml that describes this campaign initiative.