com.ibm.commerce.tools.campaigns

Interface CampaignInitiativeEvaluateCmd

All Superinterfaces:

com.ibm.commerce.rule.ActionHandler, com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.condition.Evaluator, com.ibm.commerce.command.TaskCommand

All Known Implementing Classes:

CampaignInitiativeEvaluateCmdImpl

public interface CampaignInitiativeEvaluateCmd
extends com.ibm.commerce.command.TaskCommand, com.ibm.commerce.condition.Evaluator, com.ibm.commerce.rule.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

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
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.
java.lang.String	getExperimentId() This method gets the ID of the experiment associated with the e-Marketing Spot.
java.lang.String	getTestElementId() This method gets the ID of the test element associated with the experiment running on the e-Marketing Spot.
void	refreshCommandContext(com.ibm.commerce.command.CommandContext commandContext) To be called after an execute() call to refresh the command context if this command is cached.
void	setCurrentCatalogId(java.lang.Long currentCatalogId) Sets the ID of the catalog that the shopper is currently viewing.
void	setEMarketingSpotName(java.lang.String eMarketingSpotName) Sets the e-Marketing Spot name.
void	setExperimentId(java.lang.String expId) This method sets the ID of the experiment associated with the e-Marketing Spot.
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	setResultFilter(java.util.Vector resultFilter) Sets the flag that indicates which result filter needs to be turned off.
void	setResultOrder(int resultOrder) Sets the flag that indicates the result ordering logic to be executed in the evaluate command.
void	setSourceCatalogEntryIds(java.util.Vector sourceCatalogEntryIds) Sets the list of source catalog entry IDs.
void	setSourceCatalogGroupIds(java.util.Vector sourceCatalogGroupIds) Sets the list of source catalog group IDs.
void	setTestElementId(java.lang.String testElemId) This method sets the ID of the test element associated with the experiment running on the e-Marketing Spot.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, 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

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

defaultCommandClassName

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

Name

static final java.lang.String Name

The name of this interface.

See Also:

Constant Field Values

Method Detail

getAssociateCatalogEntries

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.

getCatalogEntries

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

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

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.

getEMarketingSpotId

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.

getExperimentId

java.lang.String getExperimentId()

This method gets the ID of the experiment associated with the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.

Returns:

The ID of the experiment associated with the e-Marketing Spot. If there is no experiment associated with the e-Marketing Spot, then "NONE" is returned.

getTestElementId

java.lang.String getTestElementId()

This method gets the ID of the test element associated with the experiment running on the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.

Returns:

The ID of the test element associated with the experiment running on the e-Marketing Spot. If there is no experiment associated with the e-Marketing Spot, then "NONE" is returned.

refreshCommandContext

void refreshCommandContext(com.ibm.commerce.command.CommandContext commandContext)

To be called after an execute() call to refresh the command context if this command is cached. Implementations of this command wishing to be cached must set their CommandContext to null at the end of their performExecute() method and then reset all references to the CommandContext within this method.

Parameters:

commandContext - the CommandContext object with which to refresh the command.

setCurrentCatalogId

void setCurrentCatalogId(java.lang.Long currentCatalogId)

Sets the ID of the catalog that the shopper is currently viewing. If this is not set, then the system will assume that the master catalog of the current store is in use.

Parameters:

currentCatalogId - ID of the catalog that the shopper is currently viewing.

setEMarketingSpotName

void setEMarketingSpotName(java.lang.String eMarketingSpotName)

Sets the e-Marketing Spot name.

Parameters:

eMarketingSpotName - The name of the e-Marketing Spot selected.

setExperimentId

void setExperimentId(java.lang.String expId)

This method sets the ID of the experiment associated with the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.

Parameters:

expId - The ID of the experiment associated with the e-Marketing Spot. This is determined by the CampaignsFilter.

setMaximumNumberOfAssociateCatalogEntries

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.

setMaximumNumberOfCatalogEntries

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

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

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.

setResultFilter

void setResultFilter(java.util.Vector resultFilter)

Sets the flag that indicates which result filter needs to be turned off. By default, all result filters are turned on.

Parameters:

resultFilter - List of flag that indicates which result filter needs to be turned off.

setResultOrder

void setResultOrder(int resultOrder)

Sets the flag that indicates the result ordering logic to be executed in the evaluate command. By default, the result order will be randomized.

Parameters:

resultOrder - Result ordering flag.

setSourceCatalogEntryIds

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.

setSourceCatalogGroupIds

void setSourceCatalogGroupIds(java.util.Vector sourceCatalogGroupIds)

Sets the list of source catalog group IDs.

Parameters:

sourceCatalogGroupIds - The list of source catalog group IDs in a vector object.

setTestElementId

void setTestElementId(java.lang.String testElemId)

This method sets the ID of the test element associated with the experiment running on the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.

Parameters:

testElemId - The ID of the test element associated with the experiment running on the e-Marketing Spot. If the test element is not yet determined, then do not call this method, or set the value to null.