com.ibm.commerce.marketing.commands.marketingspot

Interface FilterCatalogEntryTaskCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, MarketingSpotCommandBaseTaskCmd, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

FilterCatalogEntryTaskCmdImpl

public interface FilterCatalogEntryTaskCmd
extends MarketingSpotCommandBaseTaskCmd

This command loads the specified catalog entry by calling the RetrieveCatalogEntryTaskCmd command. Then this command checks if the specified catalog entry qualifies for the defined filtering criteria or not. See the file samples/samples/dynacache/marketing/cachespec.xml for details about caching this command. Filters that can be cached (such as check if in the current catalog) are evaluated in the performExecute method. Filters that cannot be cached (such as check if in current shopping cart) are evaluated in the postFilter method. If a custom filter is added, and the evaluation can be cached, then extend the method removeCatalogEntry. If a custom filter is added, and the evaluation cannot be cached, then extend the method postFilter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName Default implementation class for this command.
static java.lang.String	NAME The name of this interface.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList	getCatalogEntries() This method returns an array of filtered catalog entry data objects that will be displayed in the e-Marketing Spot.
EMarketingSpotDataBean[]	getResultDataBeans() This method sets the data beans containing the results that the e-Marketing Spot displays.
boolean	postFilter(MarketingSpotActivityCatalogEntryDataType catentry) This method checks the filters that need to be evaluated every time and cannot be cached when this command is cached.
void	setResultDataBeans(EMarketingSpotDataBean[] resultDataBeans) This method sets the data beans containing the results that the e-Marketing Spot displays.

Methods inherited from interface com.ibm.commerce.marketing.commands.marketingspot.MarketingSpotCommandBaseTaskCmd

setAdditionalParameters, setMarketingSpotBehavior, setPreviewReport, setSpecificLanguageId, setSpecificStoreId

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

execute, isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this interface.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

Default implementation class for this command.

Method Detail

getCatalogEntries

java.util.ArrayList getCatalogEntries()

This method returns an array of filtered catalog entry data objects that will be displayed in the e-Marketing Spot.

Returns:

An array of filtered catalog entry data objects.

getResultDataBeans

EMarketingSpotDataBean[] getResultDataBeans()

This method sets the data beans containing the results that the e-Marketing Spot displays.

Returns:

The data beans containing the results that the e-Marketing Spot displays.

setResultDataBeans

void setResultDataBeans(EMarketingSpotDataBean[] resultDataBeans)

This method sets the data beans containing the results that the e-Marketing Spot displays. Although this method takes an array, only one EMarketingSpotDataBean can be set. This is to allow for the appropriate command caching.

Parameters:

resultDataBeans - The data beans containing the results that the e-Marketing Spot displays.

postFilter

boolean postFilter(MarketingSpotActivityCatalogEntryDataType catentry)

This method checks the filters that need to be evaluated every time and cannot be cached when this command is cached.

Parameters:

catentry - The catalog entry to check.

Returns:

This method returns true if the catalog entry should be removed because one of the remove filters has matched its criteria.