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

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

Inner Class Summary
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 item.
static class EMarketingSpot.Collateral
          Extends CollateralDataBean to provide a class that also contains information about the intitiative that recommended the item.
 
Field Summary
protected  EMarketingSpot.CatalogEntry[] _catalogEntries
          An array of CatalogEntry objects.
protected  EMarketingSpot.Category[] _categories
          An array of Category objects.
protected  EMarketingSpot.Collateral[] _collateral
          An array of Collateral objects.
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.
static java.lang.String COPYRIGHT
          Copyright.
 
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.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 the data bean.
 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.
 
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

_catalogEntries

protected EMarketingSpot.CatalogEntry[] _catalogEntries
An array of CatalogEntry objects.

_categories

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

_collateral

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

_maximumNumberOfCatalogEntries

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

_maximumNumberOfCategories

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

_maximumNumberOfCollateral

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

COPYRIGHT

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

EMarketingSpot

public EMarketingSpot()
Method Detail

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 the data bean.
Overrides:
populate in class EMarketingSpotBase

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.