com.ibm.commerce.pagelayout.facade.server.commands

Interface PageDesignEMarketingSpotListTaskCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

PageDesignEMarketingSpotListTaskCmdImpl

public interface PageDesignEMarketingSpotListTaskCmd
extends TaskCommand

Task command used to fetch the list of eSpots associated with a given pageDesign object. setPageDesign(PageDesignType) should be called before invoking execute method on this task command. It returns the list of eSpots in a hierarchical structure or in a flat list structure. Marketing components expects eSpots to be returned in hierarchical structure while evaluating the layout. Flat list of eSpots can be used in caching meta data generator.

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.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getPageDesignContributingESpotsFlatList() Return list of eSpots associated with pageDesign object in a flat list.
java.util.List<java.util.List<java.lang.String>>	getPageDesignContributingESpotsHierarchy() Return list of eSpots associated with pageDesign object in hierarchical manner.
void	setPageDesign(com.ibm.commerce.pagelayout.facade.datatypes.PageDesignType pageDesignType) Sets the pageDesign for which list of eSpots will be generated.

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

execute

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

isReadyToCallExecute, reset

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

unionDependencies

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

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

Default implementation class for this command.

Method Detail

setPageDesign

void setPageDesign(com.ibm.commerce.pagelayout.facade.datatypes.PageDesignType pageDesignType)

Sets the pageDesign for which list of eSpots will be generated.

Parameters:

pageDesignType -

getPageDesignContributingESpotsHierarchy

java.util.List<java.util.List<java.lang.String>> getPageDesignContributingESpotsHierarchy()

Return list of eSpots associated with pageDesign object in hierarchical manner.

Returns:

List of eSpots in hierarchical structure.

getPageDesignContributingESpotsFlatList

java.util.List<java.lang.String> getPageDesignContributingESpotsFlatList()

Return list of eSpots associated with pageDesign object in a flat list.

Returns:

List of eSpots associated with the pageDesign