java.lang.ObjectCacheableCommandImpl
com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.command.TaskCommandImpl
com.ibm.commerce.tools.campaigns.CampaignInitiativeEvaluateCmdImpl
This class implements the CampaignInitiativeEvaluateCmd interface to provide the task command that evaluates a campaign initiative. Different implementations of this interface can be provided for different stores.
Field Summary | |
protected java.util.Vector | _associateCatalogEntryResults Associate Catalog entry results used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected CampaignInitiativeContext | _campaignInitiativeContext An instance of the CampaignInitiativeContext object. |
protected java.lang.String | _campaignLogResults Campaign initiative log results. |
protected java.lang.String | _campaignLogSegments Campaign initiative log segments. |
protected java.util.Vector | _catalogEntryIds Catalog entry IDs used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected java.util.Vector | _catalogEntryResults Catalog entry results used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected java.util.Vector | _categoryNames Category names used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected java.util.Vector | _categoryResults Category results used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected CheckCurrentUserInMemberGroupCmd | _checkCurrentUserInMemberGroupCmd An instance of the CheckCurrentUserInMemberGroupCmd object. |
protected java.util.Vector | _collateralNames Collateral names used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected java.util.Vector | _collateralResults Collateral results used in the evaluation of this initiative on what to show in the e-Marketing Spot. |
protected java.util.Vector | _crossSellCatalogEntry Catalog entry IDs and ranks used to populate the cross-sell result to the e-Marketing Spot. |
protected java.lang.String | _dayOfWeek Campaign initiative WHEN condition a day of the week |
protected java.lang.Integer | _eMarketingSpotId e-Marketing Spot ID. |
protected java.lang.String | _eMarketingSpotName e-Marketing Spot name. |
protected InvokePersonalizationRuleServiceCommand | _invokePersonalizationRuleServiceCommand An instance of the InvokePersonalizationRuleServiceCommand object. |
protected int | _maximumNumberOfAssociateCatalogEntries Maximum number of associate catalog entries in this e-Marketing Spot. |
protected int | _maximumNumberOfCatalogEntries Maximum number of catalog entries in this e-Marketing Spot. |
protected int | _maximumNumberOfCategories Maximum number of categories in this e-Marketing Spot. |
protected int | _maximumNumberOfCollateral Maximum number of ad copies in this e-Marketing Spot. |
protected CatalogGroupResultBean[][] | _purchaseHistoryCatalogGroups An array of instances of the CatalogGroupResultBean object, used to check the purchase history. |
protected java.lang.String | _purchaseHistoryCatalogGroupsLanguage The language of the catalog group in the purchase history. |
protected java.lang.String[] | _purchaseHistoryCategories An array of the categories in the purchase history. |
protected OrderItemAccessBean[] | _purchaseHistoryOrderItems An array of instances of the OrderItemAccessBean object, used to check the purchase history. |
protected SelectQuery | _selectQuery An instance of the SelectQuery object. |
protected CatalogGroupResultBean[][] | _shoppingCartCatalogGroups An array of instances of the CatalogGroupResultBean object, used to check the shopping cart. |
protected java.lang.String | _shoppingCartCatalogGroupsLanguage The language of the catalog group in the shopping cart. |
protected OrderAccessBean | _shoppingCartOrderAccessBean An instance of the OrderAccessBean object, used to check the shopping cart. |
protected OrderItemAccessBean[] | _shoppingCartOrderItems An array of instances of the OrderItemAccessBean object, used to check the shopping cart. |
protected java.math.BigDecimal | _shoppingCartTotal The current total amount in the shopping cart. |
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. |
protected java.util.Vector | _upSellCatalogEntry Catalog entry IDs and ranks used to populate the up-sell result to the e-Marketing Spot. |
static java.lang.String | COMPONENT_RULE_BASED_DISCOUNT The element tag constant in the instance.xml to identify the rule based discount component. |
static java.lang.String | COMPONENT_USER_TRAFFIC_EVENT_LISTENER The element tag constant in the instance.xml to identify the user traffic event listener component. |
static java.lang.String | COPYRIGHT IBM copyright notice field. |
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.tools.campaigns.CampaignInitiativeEvaluateCmd |
defaultCommandClassName, Name |
Fields inherited from interface com.ibm.commerce.command.ECCommand |
defaultCommandClassName |
Constructor Summary | |
CampaignInitiativeEvaluateCmdImpl() |
Method Summary | |
protected void | addAssociateCatalogEntry(java.lang.String catalogEntryId, java.math.BigDecimal associationRank, java.lang.Integer initiativeId) The addAssociateCatalogEntry method is used to add associate catalog entries to the e-Marketing Spot, after all conditions are being successfully evaluated. |
protected void | addCatalogEntry(java.lang.String catalogEntryId, java.lang.Integer initiativeId) The addCatalogEntry method is used to add catalog entries to the e-Marketing Spot, after all conditions are being successfully evaluated. |
protected void | addCategory(java.lang.String categoryName, java.lang.Integer initiativeId, java.lang.Long[] memberIds) The addCategory method is used to add categories to the e-Marketing Spot, after all conditions are being successfully evaluated. |
protected void | addCollateral(java.lang.String collateralName, java.lang.Integer initiativeId, java.lang.Integer storeId, java.lang.Integer languageId) The addCollateral method is used to add ad copies to the e-Marketing Spot, after all conditions are being successfully evaluated. |
protected void | appendCampaignLogResults(java.lang.Object object) The appendCampaignLogResults method writes the execution log of the campaign initiative. |
boolean | evaluate(java.lang.String name, OpenCondition.Parameter[] parameters) This evaluate method is used to evaluate open conditions using rule service. |
boolean | evaluate(java.lang.String variable, java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) This evaluate method is used to evaluate simple conditions. |
protected boolean | evaluateCoupon(java.lang.String collateralName) The evaluateCoupon method is used to evaluate the WHAT condition of coupon advertisement type. |
protected boolean | evaluateDayOfWeek(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluateDayOfWeek method is used to evaluate the WHEN condition. |
protected boolean | evaluateDiscount(java.lang.String discountUsage, java.lang.String discountCode) The evaluateDiscount method is used to evaluate the WHAT condition of discount advertisement type. |
protected boolean | evaluatePurchaseHistoryCategory(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluatePurchaseHistoryCategory method is used to evaluate the WHICH condition, checking the purchase history on the specified category. |
protected boolean | evaluatePurchaseHistorySku(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluatePurchaseHistorySku method is used to evaluate the WHICH condition, checking the purchase history on the specified SKU. |
protected boolean | evaluateSegmentCondition(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluateSegmentCondition method is used to evaluate the WHO condition, comparing the target customer with the current customer in store. |
protected boolean | evaluateShoppingCartCategory(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluateShoppingCartCategory method is used to evaluate the WHICH condition, checking the shopping cart if it contains the specified category. |
protected boolean | evaluateShoppingCartSku(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluateShoppingCartSku method is used to evaluate the WHICH condition, checking the shopping cart if it contains the specified SKU. |
protected boolean | evaluateShoppingCartTotal(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers) The evaluateShoppingCartTotal method is used to evaluate the WHICH condition, comparing the shopping cart total amount with the specified amount in the condition. |
EMarketingSpot.AssociateCatalogEntry[] | getAssociateCatalogEntries() Gets the associate catalog entries to be displayed in the e-Marketing Spot. |
protected CampaignInitiativeContext | getCampaignInitiativeContext() Gets the campaign initiative context object. |
EMarketingSpot.CatalogEntry[] | getCatalogEntries() Gets the catalog entries to be displayed in the e-Marketing Spot. |
EMarketingSpot.Category[] | getCategories() Gets the categories to be displayed in the e-Marketing Spot. |
protected java.lang.String | getCategoryName(java.lang.String categoryIdentifier) Gets the category name given the category identifier. |
protected CheckCurrentUserInMemberGroupCmd | getCheckCurrentUserInMemberGroupCmd() Gets the current user in the member group. |
EMarketingSpot.Collateral[] | getCollateral() Gets the ad copies to be displayed in the e-Marketing Spot. |
protected java.lang.String | getDayOfWeek() Gets the current day of the week from the java Calendar object. |
java.lang.Integer | getEMarketingSpotId() Gets the e-Marketing Spot ID. |
protected InvokePersonalizationRuleServiceCommand | getInvokePersonalizationRuleServiceCommand() Invokes the personalization rule service. |
protected CatalogGroupResultBean[][] | getPurchaseHistoryCatalogGroups(java.lang.String language) Gets the catalog groups from the purchase history of the store. |
protected java.lang.String[] | getPurchaseHistoryCategories(java.lang.String language) Gets the categories from the purchase history of the store. |
protected OrderItemAccessBean[] | getPurchaseHistoryOrderItems() Gets the order items from the purchase history of the store. |
protected int | getSelectQueryOperator(java.lang.String operator) Gets the integer constant to be used in the SelectQuery class. |
protected CatalogGroupResultBean[][] | getShoppingCartCatalogGroups(java.lang.String language) Gets the catalog groups from the shopping cart of the store. |
protected OrderAccessBean | getShoppingCartOrderAccessBean() Gets the order item from the shopping cart of the store. |
protected OrderItemAccessBean[] | getShoppingCartOrderItems() Gets the order items from the shopping cart of the store. |
protected java.math.BigDecimal | getShoppingCartTotal(java.lang.String currency) Gets the total amount from the shopping cart of the store. |
protected WCSRecommendationServer | getWCSRecommendationServer() Gets the instance of the Likeminds Personalization Server. |
protected boolean | invokeService(java.lang.String serviceName, CampaignInitiativeContext campaignInitiativeContext) The invokeService method is used to invoke the rule service to evaluate conditions. |
boolean | isReadyToCallExecute() Checks to see if the command is ready to call. |
void | performAction(Action action) Performs the execution of the command. |
protected void | performAwarenessAd(Action.Parameter[] parameters) Performs the execution of the command, used specific to general advertisements. |
protected void | performCategoryRecommendation(Action.Parameter[] parameters) Performs the execution of the command, used specific to category recommendations. |
protected void | performCollaborativeFiltering(Action.Parameter[] parameters) Performs the execution of the command, used specific to collaborative filtering. |
protected void | performCouponAd(Action.Parameter[] parameters) Performs the execution of the command, used specific to coupon advertisements. |
protected void | performDiscountAd(Action.Parameter[] parameters) Performs the execution of the command, used specific to discount advertisements. |
void | performExecute() Performs the execution of the command. |
protected void | performProductCrossSell(Action.Parameter[] parameters) Performs the execution of the command, used specific to product cross-sell. |
protected void | performProductUpSell(Action.Parameter[] parameters) Performs the execution of the command, used specific to product up-sell. |
protected void | performSuggestiveSell(Action.Parameter[] parameters) Performs the execution of the command, used specific to suggestive sellings. |
protected boolean | populateAssociateCatalogEntryResults(java.lang.Integer initiativeId) Populates the results on associate catalog entry. |
protected boolean | populateCatalogEntryResults(java.lang.Integer initiativeId) Populates the results on catalog entry. |
protected boolean | populateCategoryResults(java.lang.Integer initiativeId) Populates the results on category. |
protected boolean | populateCollateralResults(java.lang.Integer initiativeId) Populates the results on ad copy. |
protected boolean | populateResults(java.lang.Integer initiativeId) Populates the results on all e-Marketing Spot display types. |
protected void | resetParameters() Resets all parameter objects that are used in this command. |
protected void | resetResults() Resets the results on all e-Marketing Spot display types. |
void | setEMarketingSpotName(java.lang.String eMarketingSpotName) Sets the name of the e-Marketing Spot. |
void | setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries) Sets the maximum number of associate catalog entries can be displayed in an e-Marketing Spot. |
void | setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries) Sets the maximum number of catalog entries can be displayed in an e-Marketing Spot. |
void | setMaximumNumberOfCategories(int maximumNumberOfCategories) Sets the maximum number of categories can be displayed in an e-Marketing Spot. |
void | setMaximumNumberOfCollateral(int maximumNumberOfCollateral) Sets the maximum number of ad copies can be displayed in an e-Marketing Spot. |
void | setSourceCatalogEntryIds(java.util.Vector sourceCatalogEntryIds) Sets the list of source catalog entry IDs. |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final java.lang.String COMPONENT_RULE_BASED_DISCOUNT
public static final java.lang.String COMPONENT_USER_TRAFFIC_EVENT_LISTENER
protected java.util.Vector _sourceCatalogEntryIds
protected java.lang.String _eMarketingSpotName
protected java.lang.Integer _eMarketingSpotId
protected int _maximumNumberOfCatalogEntries
protected int _maximumNumberOfCollateral
protected int _maximumNumberOfCategories
protected int _maximumNumberOfAssociateCatalogEntries
protected CheckCurrentUserInMemberGroupCmd _checkCurrentUserInMemberGroupCmd
protected java.lang.String _dayOfWeek
protected OrderAccessBean _shoppingCartOrderAccessBean
protected OrderItemAccessBean[] _shoppingCartOrderItems
protected CatalogGroupResultBean[][] _shoppingCartCatalogGroups
protected java.lang.String _shoppingCartCatalogGroupsLanguage
protected OrderItemAccessBean[] _purchaseHistoryOrderItems
protected CatalogGroupResultBean[][] _purchaseHistoryCatalogGroups
protected java.lang.String _purchaseHistoryCatalogGroupsLanguage
protected java.lang.String[] _purchaseHistoryCategories
protected CampaignInitiativeContext _campaignInitiativeContext
protected java.math.BigDecimal _shoppingCartTotal
protected SelectQuery _selectQuery
protected java.util.Vector _catalogEntryIds
protected java.util.Vector _collateralNames
protected java.util.Vector _categoryNames
protected java.util.Vector _upSellCatalogEntry
protected java.util.Vector _crossSellCatalogEntry
protected java.util.Vector _associateCatalogEntryResults
protected java.util.Vector _catalogEntryResults
protected java.util.Vector _collateralResults
protected java.util.Vector _categoryResults
protected java.lang.String _campaignLogResults
protected java.lang.String _campaignLogSegments
protected InvokePersonalizationRuleServiceCommand _invokePersonalizationRuleServiceCommand
Constructor Detail |
public CampaignInitiativeEvaluateCmdImpl()
Method Detail |
protected void addAssociateCatalogEntry(java.lang.String catalogEntryId, java.math.BigDecimal associationRank, java.lang.Integer initiativeId)
protected void addCatalogEntry(java.lang.String catalogEntryId, java.lang.Integer initiativeId)
protected void addCategory(java.lang.String categoryName, java.lang.Integer initiativeId, java.lang.Long[] memberIds)
protected void addCollateral(java.lang.String collateralName, java.lang.Integer initiativeId, java.lang.Integer storeId, java.lang.Integer languageId)
public boolean evaluate(java.lang.String name, OpenCondition.Parameter[] parameters)
public boolean evaluate(java.lang.String variable, java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluateDayOfWeek(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluateDiscount(java.lang.String discountUsage, java.lang.String discountCode) throws java.lang.Exception
protected boolean evaluateCoupon(java.lang.String collateralName) throws java.lang.Exception
protected boolean evaluatePurchaseHistoryCategory(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluatePurchaseHistorySku(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluateSegmentCondition(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluateShoppingCartCategory(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluateShoppingCartSku(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected boolean evaluateShoppingCartTotal(java.lang.String operator, java.lang.String value, SimpleCondition.Qualifier[] qualifiers)
protected CampaignInitiativeContext getCampaignInitiativeContext()
public EMarketingSpot.AssociateCatalogEntry[] getAssociateCatalogEntries()
public EMarketingSpot.CatalogEntry[] getCatalogEntries()
public EMarketingSpot.Category[] getCategories()
protected java.lang.String getCategoryName(java.lang.String categoryIdentifier)
protected CheckCurrentUserInMemberGroupCmd getCheckCurrentUserInMemberGroupCmd()
protected InvokePersonalizationRuleServiceCommand getInvokePersonalizationRuleServiceCommand()
public EMarketingSpot.Collateral[] getCollateral()
protected java.lang.String getDayOfWeek()
public java.lang.Integer getEMarketingSpotId()
protected CatalogGroupResultBean[][] getPurchaseHistoryCatalogGroups(java.lang.String language)
protected java.lang.String[] getPurchaseHistoryCategories(java.lang.String language)
protected OrderItemAccessBean[] getPurchaseHistoryOrderItems()
protected int getSelectQueryOperator(java.lang.String operator)
protected CatalogGroupResultBean[][] getShoppingCartCatalogGroups(java.lang.String language)
protected OrderAccessBean getShoppingCartOrderAccessBean()
protected OrderItemAccessBean[] getShoppingCartOrderItems()
protected java.math.BigDecimal getShoppingCartTotal(java.lang.String currency)
protected boolean invokeService(java.lang.String serviceName, CampaignInitiativeContext campaignInitiativeContext)
public boolean isReadyToCallExecute()
public void performAction(Action action)
protected void performAwarenessAd(Action.Parameter[] parameters)
protected void performDiscountAd(Action.Parameter[] parameters)
protected void performCouponAd(Action.Parameter[] parameters)
protected void performCategoryRecommendation(Action.Parameter[] parameters)
protected void performCollaborativeFiltering(Action.Parameter[] parameters)
protected void performProductUpSell(Action.Parameter[] parameters)
protected void performProductCrossSell(Action.Parameter[] parameters)
public void performExecute() throws ECException
protected void performSuggestiveSell(Action.Parameter[] parameters)
protected boolean populateAssociateCatalogEntryResults(java.lang.Integer initiativeId)
protected boolean populateCatalogEntryResults(java.lang.Integer initiativeId)
protected boolean populateCategoryResults(java.lang.Integer initiativeId)
protected boolean populateCollateralResults(java.lang.Integer initiativeId)
protected boolean populateResults(java.lang.Integer initiativeId)
protected void resetParameters()
protected void resetResults()
public void setSourceCatalogEntryIds(java.util.Vector sourceCatalogEntryIds)
public void setEMarketingSpotName(java.lang.String eMarketingSpotName)
public void setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries)
public void setMaximumNumberOfCategories(int maximumNumberOfCategories)
public void setMaximumNumberOfCollateral(int maximumNumberOfCollateral)
public void setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries)
protected WCSRecommendationServer getWCSRecommendationServer()
protected void appendCampaignLogResults(java.lang.Object object)
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.