com.ibm.commerce.marketing.beans
Class EMarketingSpot

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.marketing.beans.EMarketingSpotBase
                    |
                    +--com.ibm.commerce.marketing.beans.EMarketingSpot
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean
Direct Known Subclasses:
AwarenessAdvertisementMPE, CatalogEntryMPE

public class EMarketingSpot
extends EMarketingSpotBase

The e-Marketing Spot bean. This bean will return the results of campaign initiatives that are currently scheduled onto it.

See Also:
Serialized Form

Nested Class Summary
static class EMarketingSpot.AssociateCatalogEntry
          Extends CatalogEntryDataBean to provide a class that also contains information about the intitiative that recommended the associated item.
static class EMarketingSpot.CatalogEntry
          Extends CatalogEntryDataBean to provide a class that also contains information about the intitiative that recommended the item.
static class EMarketingSpot.Category
          Extends CategoryDataBean to provide a class that also contains information about the intitiative that recommended the category.
static class EMarketingSpot.Collateral
          Extends CollateralDataBean to provide a class that also contains information about the intitiative that recommended the ad copy.
 
Field Summary
protected   EMarketingSpot.AssociateCatalogEntry[] _associateCatalogEntries
          An array of the associated catalog entry objects.
protected   EMarketingSpot.CatalogEntry[] _catalogEntries
          An array of the catalog entry objects.
protected   EMarketingSpot.Category[] _categories
          An array of the category objects.
protected   EMarketingSpot.Collateral[] _collateral
          An array of the collateral objects.
protected  int _maximumNumberOfAssociateCatalogEntries
          Maximum number of AssociateCatalogEntry objects that can be returned.
protected  int _maximumNumberOfCatalogEntries
          Maximum number of CatalogEntry objects that can be returned.
protected  int _maximumNumberOfCategories
          Maximum number of Category objects that can be returned.
protected  int _maximumNumberOfCollateral
          Maximum number of Collateral objects that can be returned.
protected  java.util.Vector _sourceCatalogEntryIds
          The list of source catalog entry IDs that will be used to find all cross-sell and up-sell products.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Fields inherited from class com.ibm.commerce.marketing.beans. EMarketingSpotBase
_id, _name, evaluateCmd
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
EMarketingSpot()
           
 
Method Summary
  EMarketingSpot.AssociateCatalogEntry[] getAssociateCatalogEntries()
          Gets the associate catalog entries that were recommended by the initiatives scheduled on this e-Marketing Spot.
  EMarketingSpot.CatalogEntry[] getCatalogEntries()
          Gets the catalog entries that were recommended by the initiatives scheduled on this e-Marketing Spot.
  EMarketingSpot.Category[] getCategories()
          Gets the categories that were recommended by the initiatives scheduled on this e-Marketing Spot.
  EMarketingSpot.Collateral[] getCollateral()
          Gets the collateral items that were recommended by the initiatives scheduled on this e-Marketing Spot.
 void populate()
          Populates this data bean that represents the e-Marketing Spot on a store page.
 void setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries)
          Sets the maximum number of associate catalog entries that are to be returned by this e-Marketing Spot.
 void setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries)
          Sets the maximum number of catalog entries that are to be returned by this e-Marketing Spot.
 void setMaximumNumberOfCategories(int maximumNumberOfCategories)
          Sets the maximum number of categories that are to be returned by this e-Marketing Spot.
 void setMaximumNumberOfCollateral(int maximumNumberOfCollateral)
          Sets the maximum number of collateral items that are to be returned by this e-Marketing Spot.
 void setMultipleSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
          Adds a source catalog entry ID to the list in a vector object.
 void setSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
          Sets the source catalog entry ID.
 
Methods inherited from class com.ibm.commerce.marketing.beans. EMarketingSpotBase
getId, setName
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

_maximumNumberOfCatalogEntries

protected int _maximumNumberOfCatalogEntries
Maximum number of CatalogEntry objects that can be returned.

_maximumNumberOfCollateral

protected int _maximumNumberOfCollateral
Maximum number of Collateral objects that can be returned.

_maximumNumberOfCategories

protected int _maximumNumberOfCategories
Maximum number of Category objects that can be returned.

_maximumNumberOfAssociateCatalogEntries

protected int _maximumNumberOfAssociateCatalogEntries
Maximum number of AssociateCatalogEntry objects that can be returned.

_sourceCatalogEntryIds

protected java.util.Vector _sourceCatalogEntryIds
The list of source catalog entry IDs that will be used to find all cross-sell and up-sell products.

_catalogEntries

protected EMarketingSpot.CatalogEntry[] _catalogEntries
An array of the catalog entry objects.

_collateral

protected EMarketingSpot.Collateral[] _collateral
An array of the collateral objects.

_categories

protected EMarketingSpot.Category[] _categories
An array of the category objects.

_associateCatalogEntries

protected EMarketingSpot.AssociateCatalogEntry[] _associateCatalogEntries
An array of the associated catalog entry objects.
Constructor Detail

EMarketingSpot

public EMarketingSpot()
Method Detail

getAssociateCatalogEntries

public EMarketingSpot.AssociateCatalogEntry[] getAssociateCatalogEntries()
Gets the associate catalog entries that were recommended by the initiatives scheduled on this e-Marketing Spot.
Returns:
an array of AssociateCatalogEntry objects

getCatalogEntries

public EMarketingSpot.CatalogEntry[] getCatalogEntries()
Gets the catalog entries that were recommended by the initiatives scheduled on this e-Marketing Spot.
Returns:
an array of CatalogEntry objects

getCategories

public EMarketingSpot.Category[] getCategories()
Gets the categories that were recommended by the initiatives scheduled on this e-Marketing Spot.
Returns:
an array of Category objects

getCollateral

public EMarketingSpot.Collateral[] getCollateral()
Gets the collateral items that were recommended by the initiatives scheduled on this e-Marketing Spot.
Returns:
an array of Collateral objects

populate

public void populate()
              throws java.lang.Exception
Populates this data bean that represents the e-Marketing Spot on a store page.
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class EMarketingSpotBase
Throws:
java.lang.Exception - Thrown when an error occurs during the population of this data bean.

setSourceCatalogEntryId

public void setSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
Sets the source catalog entry ID.
Parameters:
sourceCatalogEntryId - The source catalog entry ID.

setMultipleSourceCatalogEntryId

public void setMultipleSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
Adds a source catalog entry ID to the list in a vector object.
Parameters:
sourceCatalogEntryId - The source catalog entry ID to be added to the list in a vector object.

setMaximumNumberOfCatalogEntries

public void setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries)
Sets the maximum number of catalog entries that are to be returned by this e-Marketing Spot.
Parameters:
maximumNumberOfCatalogEntries - Maximum number of catalog entries.

setMaximumNumberOfCategories

public void setMaximumNumberOfCategories(int maximumNumberOfCategories)
Sets the maximum number of categories that are to be returned by this e-Marketing Spot.
Parameters:
maximumNumberOfCategories - Maximum number of categories.

setMaximumNumberOfCollateral

public void setMaximumNumberOfCollateral(int maximumNumberOfCollateral)
Sets the maximum number of collateral items that are to be returned by this e-Marketing Spot.
Parameters:
maximumNumberOfCollateral - Maximum number of collateral items.

setMaximumNumberOfAssociateCatalogEntries

public void setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries)
Sets the maximum number of associate catalog entries that are to be returned by this e-Marketing Spot.
Parameters:
maximumNumberOfAssociateCatalogEntries - Maximum number of associate catalog entries.