com.ibm.commerce.tools.campaigns
Interface CampaignInitiativeEvaluateCmd

All Superinterfaces:
ActionHandler, ECCommand, Evaluator, TaskCommand
All Known Implementing Classes:
CampaignInitiativeEvaluateCmdImpl

public interface CampaignInitiativeEvaluateCmd
extends TaskCommand, Evaluator, ActionHandler

The CampaignInitiativeEvaluatorCmd interface must be implemented to provide a task command that evaluates campaign initiatives. Different implementations of this interface can be provided for different stores.


Field Summary
static java.lang.String COPYRIGHT
          Copyright.
static java.lang.String defaultCommandClassName
          defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.tools.campaigns.CampaignInitiativeEvaluateCmd is not defined in the CMDREG table.
static java.lang.String Name
          The name of this interface.
 
Method Summary
 EMarketingSpot.CatalogEntry[] getCatalogEntries()
          An array of EMarketingSpot.CatalogEntry objects.
 EMarketingSpot.Category[] getCategories()
          An array of EMarketingSpot.Category objects.
 EMarketingSpot.Collateral[] getCollateral()
          An array of EMarketingSpot.Collateral objects.
 java.lang.Integer getEMarketingSpotId()
          Returns the e-marketing spot ID of the specified e-marketing spot.
 void setEMarketingSpotName(java.lang.String eMarketingSpotName)
          Sets the e-marketing spot name.
 void setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries)
          Sets the maximum number of catalog entries to be shown in the e-marketing spot.
 void setMaximumNumberOfCategories(int maximumNumberOfCategories)
          Sets the maximum number of catalog groups to be shown in the e-marketing spot.
 void setMaximumNumberOfCollateral(int maximumNumberOfCollateral)
          Sets the maximum number of ad copies to be shown in the e-marketing spot.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.condition.Evaluator
evaluate, evaluate
 
Methods inherited from interface com.ibm.commerce.rule.ActionHandler
performAction
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.tools.campaigns.CampaignInitiativeEvaluateCmd is not defined in the CMDREG table.

Name

public static final java.lang.String Name
The name of this interface.
Method Detail

getCatalogEntries

public EMarketingSpot.CatalogEntry[] getCatalogEntries()
An array of EMarketingSpot.CatalogEntry objects.

getCategories

public EMarketingSpot.Category[] getCategories()
An array of EMarketingSpot.Category objects.

getCollateral

public EMarketingSpot.Collateral[] getCollateral()
An array of EMarketingSpot.Collateral objects.

getEMarketingSpotId

public java.lang.Integer getEMarketingSpotId()
Returns the e-marketing spot ID of the specified e-marketing spot. You must execute this task command before accessing this value.
Returns:
An integer of the e-marketing spot ID.

setEMarketingSpotName

public void setEMarketingSpotName(java.lang.String eMarketingSpotName)
Sets the e-marketing spot name.
Parameters:
eMarketingSpotName - The name of the e-marketing spot selected.

setMaximumNumberOfCatalogEntries

public void setMaximumNumberOfCatalogEntries(int maximumNumberOfCatalogEntries)
Sets the maximum number of catalog entries to be shown in the e-marketing spot.
Parameters:
maximumNumberOfCatalogEntries - The maximum number of the catalog entries to be shown in the e-marketing spot.

setMaximumNumberOfCategories

public void setMaximumNumberOfCategories(int maximumNumberOfCategories)
Sets the maximum number of catalog groups to be shown in the e-marketing spot.
Parameters:
maximumNumberOfCategories - The maximum number of the catalog groups to be shown in the e-marketing spot.

setMaximumNumberOfCollateral

public void setMaximumNumberOfCollateral(int maximumNumberOfCollateral)
Sets the maximum number of ad copies to be shown in the e-marketing spot.
Parameters:
maximumNumberOfCollateral - The maximum number of the ad copies to be shown in the e-marketing spot.