com.ibm.commerce.tools.campaigns
Interface CampaignInitiativeEvaluateCmd

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

public interface CampaignInitiativeEvaluateCmd
extends TaskCommand, Evaluator, ActionHandler

This 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
          IBM copyright notice field.
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.AssociateCatalogEntry[] getAssociateCatalogEntries()
          An array of EMarketingSpot.AssociateCatalogEntry objects that represent all the associated catalog entry result in this e-Marketing Spot.
  EMarketingSpot.CatalogEntry[] getCatalogEntries()
          An array of EMarketingSpot.CatalogEntry objects that represent all the catalog entry result in this e-Marketing Spot.
  EMarketingSpot.Category[] getCategories()
          An array of EMarketingSpot.getCategories objects that represent all the category result in this e-Marketing Spot.
  EMarketingSpot.Collateral[] getCollateral()
          An array of EMarketingSpot.Collateral objects that represent all the collateral result in this e-Marketing Spot.
 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 setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries)
          Sets the maximum number of associate catalog entries to be shown in the e-Marketing Spot.
 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.
 void setSourceCatalogEntryIds(java.util.Vector sourceCatalogEntryIds)
          Sets the list of source catalog entry IDs.
 
Methods inherited from interface com.ibm.commerce.condition. Evaluator
evaluate, evaluate
 
Methods inherited from interface com.ibm.commerce.rule. ActionHandler
performAction
 

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

Name

public static final java.lang.String Name
The name of this interface.
See Also:
Constant Field Values

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.
See Also:
Constant Field Values
Method Detail

getCatalogEntries

public EMarketingSpot.CatalogEntry[] getCatalogEntries()
An array of EMarketingSpot.CatalogEntry objects that represent all the catalog entry result in this e-Marketing Spot.
Returns:
an array of catalog entries

getCategories

public EMarketingSpot.Category[] getCategories()
An array of EMarketingSpot.getCategories objects that represent all the category result in this e-Marketing Spot.
Returns:
an array of categories

getCollateral

public EMarketingSpot.Collateral[] getCollateral()
An array of EMarketingSpot.Collateral objects that represent all the collateral result in this e-Marketing Spot.
Returns:
an array of collateral

getAssociateCatalogEntries

public EMarketingSpot.AssociateCatalogEntry[] getAssociateCatalogEntries()
An array of EMarketingSpot.AssociateCatalogEntry objects that represent all the associated catalog entry result in this e-Marketing Spot.
Returns:
an array of associated catalog entries

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.

setSourceCatalogEntryIds

public void setSourceCatalogEntryIds(java.util.Vector sourceCatalogEntryIds)
Sets the list of source catalog entry IDs.
Parameters:
sourceCatalogEntryIds - The list of source catalog entry IDs in a vector object.

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.

setMaximumNumberOfAssociateCatalogEntries

public void setMaximumNumberOfAssociateCatalogEntries(int maximumNumberOfAssociateCatalogEntries)
Sets the maximum number of associate catalog entries to be shown in the e-Marketing Spot.
Parameters:
maximumNumberOfAssociateCatalogEntries - The maximum number of the associate catalog entries to be shown in the e-Marketing Spot.