public class EMarketingSpot extends EMarketingSpotBase
Modifier and Type | Class and Description |
---|---|
static class |
EMarketingSpot.AssociateCatalogEntry
Extends
CatalogEntryDataBean to provide a class that also contains information
about the activity that recommended the associated item. |
static class |
EMarketingSpot.CatalogEntry
Extends the
CatalogEntryDataBean to provide a class that also contains
information about the intitiative that recommended the item. |
static class |
EMarketingSpot.Category
Extends the
CategoryDataBean to provide a class that also contains information
about the intitiative that recommended the category. |
static class |
EMarketingSpot.Collateral
Extends the
CollateralDataBean to provide a class that also contains information
about the intitiative that recommended the ad copy. |
Modifier and Type | Field and Description |
---|---|
static int |
ALL_FILTERS
Constant for result filter type: All filters.
|
static int |
ASSOCIATE_CATENTRY_ALLOW_TO_DISPLAY
Constant for result filter type: Associated catalog entry is allowed to display.
|
static int |
ASSOCIATE_CATENTRY_ENTITLED_IN_CONTRACT
Constant for result filter type: Associated catalog entry included in contract entitlement.
|
static int |
ASSOCIATE_CATENTRY_EXIST_IN_SHOPCART
Constant for result filter type: Associated catalog entry already exists in the current
shopping cart.
|
static int |
ASSOCIATE_CATENTRY_IN_CURRENT_CATALOG
Constant for result filter type: Associated catalog entry within the current catalog.
|
static int |
ASSOCIATE_CATENTRY_NOT_EXPIRED
Constant for result filter type: Associated catalog entry has not expired.
|
static int |
ASSOCIATE_CATENTRY_NOT_MARK_FOR_DELETE
Constant for result filter type: Associated catalog entry is not marked for delete.
|
static int |
ASSOCIATE_CATENTRY_WITH_INVENTORY
Constant for result filter type: Associated catalog entry satisfies the inventory level
requirement.
|
static int |
CATEGORY_ALLOW_TO_DISPLAY
Constant for result filter type: Category is allowed to display.
|
static int |
CATEGORY_ENTITLED_IN_CONTRACT
Constant for result filter type: Category is included in contract entitlement.
|
static int |
CATEGORY_IN_CURRENT_CATALOG
Constant for result filter type: Category within the current catalog.
|
static int |
CATEGORY_NOT_MARK_FOR_DELETE
Constant for result filter type: Category is not marked for delete.
|
static int |
CATENTRY_ALLOW_TO_DISPLAY
Constant for result filter type: Catalog entry is allowed to display.
|
static int |
CATENTRY_ENTITLED_IN_CONTRACT
Constant for result filter type: Catalog entry included in contract entitlement.
|
static int |
CATENTRY_EXIST_IN_SHOPCART
Constant for result filter type: Catalog entry already exists in the current shopping cart.
|
static int |
CATENTRY_IN_CURRENT_CATALOG
Constant for result filter type: Catalog entry within the current catalog.
|
static int |
CATENTRY_NO_DUPLICATE
Constant for result filter type: No multiple catalog items for the same product.
|
static int |
CATENTRY_NOT_EXPIRED
Constant for result filter type: Catalog entry has not expired.
|
static int |
CATENTRY_NOT_MARK_FOR_DELETE
Constant for result filter type: Catalog entry is not marked for delete.
|
static int |
CATENTRY_WITH_INVENTORY
Constant for result filter type: Catalog entry satisfies the inventory level requirement.
|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
static java.lang.String |
EMS_REQUEST_ATTRIBUTE_CONTAINER_NAME
The name of the request attribute hashtable object set in the request that contains the pre-populated EMarketingSpot beans.
|
static int |
ESPOT_RESULT_ORDER_ORIGINAL
Constant for result order type: Order of result is the same as the order of selecting the
content when the Web activity was created.
|
static int |
ESPOT_RESULT_ORDER_RANDOM
Constant for result order type: Order of result is randomized.
|
static int |
PROMOTION_CONTENT_ENTITLED_IN_CONTRACT
Constant for result filter type: Promotion content included in contract entitlement.
|
useDialogMarketing
Constructor and Description |
---|
EMarketingSpot()
Constructor for EMarketingSpot.
|
Modifier and Type | Method and Description |
---|---|
static void |
callProcessMarketingTriggerWebServiceClearEntireCacheAction()
This method calls the marketing web service to clear the marketing cache.
|
static void |
callProcessMarketingTriggerWebServiceClickAction(java.util.Hashtable nameValuePairs)
This method calls the marketing web service to register a click on an eMarketing Spot.
|
static void |
callProcessMarketingTriggerWebServiceEvaluateOrderAction(java.util.Hashtable nameValuePairs)
This method calls the marketing web service to evaluate an order and determine if
it was influenced by the data displayed to the customer in an eMarketing Spot.
|
java.lang.String |
generateEMSCacheValue()
This method creates a cache key for this e-Marketing Spot.
|
EMarketingSpot.AssociateCatalogEntry[] |
getAssociateCatalogEntries()
Gets the associated 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.
|
static boolean |
getUseDialogMarketing()
This method gets if the store has enabled the dialog marketing functionality.
|
boolean |
isContainAnyResults()
Determines whether this e-Marketing Spot has objects of any types.
|
boolean |
isContainAssociateCatalogEntries()
Determines whether this e-Marketing Spot has any associated catalog entry objects.
|
boolean |
isContainCatalogEntries()
Determines whether this e-Marketing Spot has any catalog entry objects.
|
boolean |
isContainCategories()
Determines whether this e-Marketing Spot has any category objects.
|
boolean |
isContainCollateral()
Determines whether this e-Marketing Spot has any collateral objects.
|
void |
populate()
Populates this data bean representing the e-Marketing Spot on a store page.
|
void |
setCategoryId(java.lang.String sourceCategoryId)
Sets the ID of the category that the shopper is currently viewing.
|
void |
setCurrentCatalogId(java.lang.Long currentCatalogId)
Sets the ID of the catalog that the shopper is currently viewing.
|
void |
setDefaultResultFilter()
Sets the result filters to values different than their default values.
|
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 |
setMultipleSourceCatalogGroupId(java.lang.String sourceCatalogGroupId)
Adds a source catalog group ID to the list in a vector object.
|
void |
setNVP(java.lang.String name,
java.lang.String value)
Sets name/value pairs that will be used as part of the request parameters.
|
void |
setResultFilterOff(int attribute)
Sets the flag that indicates which result filter needs to be turned off.
|
void |
setResultFilterOn(int attribute)
Sets the flag that indicates which result filter needs to be turned on.
|
void |
setResultOrder(int attribute)
Sets the flag that indicates the result ordering logic to be executed in the evaluate command.
|
void |
setSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
Sets the source catalog entry ID.
|
void |
setSourceCatalogGroupId(java.lang.String sourceCatalogGroupId)
Sets the source catalog group ID.
|
void |
setStoreId(java.lang.Integer storeId)
Sets the ID of the store to which this e-Marketing Spot has access.
|
void |
setUserId(java.lang.Long userId)
Sets the ID of the user accessing this e-Marketing Spot.
|
getExperimentId, getId, getMarketingSpotData, getName, getTestElementId, setExperimentId, setName, setTestElementId, setUseDialogMarketing
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
public static final int ALL_FILTERS
public static final int ASSOCIATE_CATENTRY_ALLOW_TO_DISPLAY
public static final int ASSOCIATE_CATENTRY_ENTITLED_IN_CONTRACT
public static final int ASSOCIATE_CATENTRY_EXIST_IN_SHOPCART
public static final int ASSOCIATE_CATENTRY_IN_CURRENT_CATALOG
public static final int ASSOCIATE_CATENTRY_NOT_EXPIRED
public static final int ASSOCIATE_CATENTRY_NOT_MARK_FOR_DELETE
public static final int ASSOCIATE_CATENTRY_WITH_INVENTORY
public static final int CATEGORY_ALLOW_TO_DISPLAY
public static final int CATEGORY_ENTITLED_IN_CONTRACT
public static final int CATEGORY_IN_CURRENT_CATALOG
public static final int CATEGORY_NOT_MARK_FOR_DELETE
public static final int CATENTRY_ALLOW_TO_DISPLAY
public static final int CATENTRY_ENTITLED_IN_CONTRACT
public static final int CATENTRY_EXIST_IN_SHOPCART
public static final int CATENTRY_IN_CURRENT_CATALOG
public static final int CATENTRY_NO_DUPLICATE
public static final int CATENTRY_NOT_EXPIRED
public static final int CATENTRY_NOT_MARK_FOR_DELETE
public static final int CATENTRY_WITH_INVENTORY
public static final java.lang.String COPYRIGHT
public static final java.lang.String EMS_REQUEST_ATTRIBUTE_CONTAINER_NAME
public static final int ESPOT_RESULT_ORDER_ORIGINAL
public static final int ESPOT_RESULT_ORDER_RANDOM
public static final int PROMOTION_CONTENT_ENTITLED_IN_CONTRACT
public static void callProcessMarketingTriggerWebServiceClearEntireCacheAction()
public static void callProcessMarketingTriggerWebServiceClickAction(java.util.Hashtable nameValuePairs)
nameValuePairs
- The name value pairs containing the ID of the activity and
the ID of the eMarketing Spot.public static void callProcessMarketingTriggerWebServiceEvaluateOrderAction(java.util.Hashtable nameValuePairs)
nameValuePairs
- The name value pairs containing the ID of the order.public java.lang.String generateEMSCacheValue()
public EMarketingSpot.AssociateCatalogEntry[] getAssociateCatalogEntries()
AssociateCatalogEntry
objects.public EMarketingSpot.CatalogEntry[] getCatalogEntries()
CatalogEntry
objects.public EMarketingSpot.Category[] getCategories()
Category
objects.public EMarketingSpot.Collateral[] getCollateral()
Collateral
objects.public static boolean getUseDialogMarketing()
public boolean isContainAnyResults()
public boolean isContainAssociateCatalogEntries()
public boolean isContainCatalogEntries()
public boolean isContainCategories()
public boolean isContainCollateral()
public void populate() throws java.lang.Exception
populate
in interface com.ibm.commerce.beans.SmartDataBean
populate
in class EMarketingSpotBase
java.lang.Exception
- Thrown when an error occurs during the population of this data bean.public void setCategoryId(java.lang.String sourceCategoryId)
sourceCategoryId
- The ID of the category that the shopper is currently viewing.public void setCurrentCatalogId(java.lang.Long currentCatalogId)
currentCatalogId
- ID of the catalog that the shopper is currently viewing.public void setDefaultResultFilter()
public void setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries)
maximumNumberOfAssociateCatalogEntries
- Maximum number of associate catalog entries.public void setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries)
maximumNumberOfCatalogEntries
- Maximum number of catalog entries.public void setMaximumNumberOfCategories(int maximumNumberOfCategories)
maximumNumberOfCategories
- Maximum number of categories.public void setMaximumNumberOfCollateral(int maximumNumberOfCollateral)
maximumNumberOfCollateral
- Maximum number of collateral items.public void setMultipleSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
sourceCatalogEntryId
- The source catalog entry ID to be added to the list in a vector object.public void setMultipleSourceCatalogGroupId(java.lang.String sourceCatalogGroupId)
sourceCatalogGroupId
- The source catalog group ID to be added to the list in a vector object.public void setNVP(java.lang.String name, java.lang.String value)
name
- The name in the name/value pair.value
- The value in the name/value pairpublic void setResultFilterOff(int attribute)
attribute
- The result filtering flag.public void setResultFilterOn(int attribute)
attribute
- The result filtering flag.public void setResultOrder(int attribute)
attribute
- The result ordering flag.public void setSourceCatalogEntryId(java.lang.String sourceCatalogEntryId)
sourceCatalogEntryId
- The source catalog entry ID.public void setSourceCatalogGroupId(java.lang.String sourceCatalogGroupId)
sourceCatalogGroupId
- The source catalog group ID.public void setStoreId(java.lang.Integer storeId)
storeId
- The ID of the store to which this e-Marketing Spot has access.public void setUserId(java.lang.Long userId)
userId
- The ID of the user accessing this e-Marketing Spot.