com.ibm.commerce.pagelayout.widget.management.impl

Class DefaultContentAndWebActivityWidgetManager

java.lang.Object

com.ibm.commerce.pagelayout.widget.management.impl.DefaultWidgetManager

com.ibm.commerce.pagelayout.widget.management.impl.MarketingWidgetManager

com.ibm.commerce.pagelayout.widget.management.impl.DefaultContentWidgetManager

com.ibm.commerce.pagelayout.widget.management.impl.DefaultContentAndWebActivityWidgetManager

All Implemented Interfaces:

WidgetManager

Direct Known Subclasses:

CategoryRecommendationWidgetManager, ContentRecommendationWidgetManager, ProductRecommendationWidgetManager, RotatingContentWidgetManager

public class DefaultContentAndWebActivityWidgetManager
extends DefaultContentWidgetManager

This is the widget manager associates default marketing content for the content recommendation page composer widget.

It creates, updates, deletes and gets default marketing content associated with an e-marketing spot belonging to a widget within a layout.

If configured to use a web activity to populate this widget, this class will manage the e-marketing spot associated with the widget with its associated web activity.

See Also:

DefaultContentWidgetManager

Field Summary

Fields inherited from interface com.ibm.commerce.pagelayout.widget.management.spi.WidgetManager

CURRENT_ENVIRONMENT, EXECUTION_TYPE_J2EE, EXECUTION_TYPE_J2SE

Constructor Summary

Constructors

Constructor and Description
DefaultContentAndWebActivityWidgetManager()

Method Summary

Modifier and Type	Method and Description
void	createExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method will create extended data for and related to this widget.
void	deleteExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method will delete the extended data for this widget.
void	retrieveExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget widgetSDO, java.lang.Integer[] storePath, java.lang.Integer[] languageIds, SelectionCriteria criteria, java.lang.Object... parameters) This methods retrieves extended data which are common to all widgets.
void	update(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method performs no-operation.

Methods inherited from class com.ibm.commerce.pagelayout.widget.management.impl.DefaultContentWidgetManager

updateExtendedData

Methods inherited from class com.ibm.commerce.pagelayout.widget.management.impl.MarketingWidgetManager

create, delete, undo

Methods inherited from class com.ibm.commerce.pagelayout.widget.management.impl.DefaultWidgetManager

getWidgetDefinition, init, retrieve, retrieve, validateChange, validateChangeExtendedData, validateCreate, validateCreateExtendedData, validateDelete, validateDeleteExtendedData

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultContentAndWebActivityWidgetManager

public DefaultContentAndWebActivityWidgetManager()

Method Detail

createExtendedData

public void createExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                               com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                               com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtData,
                               com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                        throws LayoutException

This method will create extended data for and related to this widget.

The superclass DefaultContentWidgetManager will be called to create default content associated to this widget.

Specified by:

createExtendedData in interface WidgetManager

Overrides:

createExtendedData in class DefaultContentWidgetManager

Parameters:

aLayout - The layout object to which the widget belongs to.

aWidget - The widget where the extended data is being created.

aExtData - The extended data being created from the page layout.

aWidgetSDO - The physical data object object of the widget.

Throws:

LayoutException - This exception will be thrown if an error occurred when deleting the marketing default content.

See Also:

DefaultContentWidgetManager.createExtendedData(LayoutType, WidgetType, ExtendedDataType, PageLayoutWidget)

retrieveExtendedData

public void retrieveExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout,
                                 com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget,
                                 com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget widgetSDO,
                                 java.lang.Integer[] storePath,
                                 java.lang.Integer[] languageIds,
                                 SelectionCriteria criteria,
                                 java.lang.Object... parameters)
                          throws LayoutException

This methods retrieves extended data which are common to all widgets. Subclasses should call this super method before implementing custom behavior.

Specified by:

retrieveExtendedData in interface WidgetManager

Overrides:

retrieveExtendedData in class DefaultContentWidgetManager

Parameters:

layout - The layout object to which the widget belongs to.

widget - The widget object that needs to be populated.

widgetSDO - The physical data object of the widget.

storePath - The store path of the request.

languageIds - The requested language ids.

criteria - The selection criteria of the request.

parameters - This list would contain the selection criteria object.

Throws:

LayoutException - This exception is thrown when error occurs while retrieving the widget display title information.

deleteExtendedData

public void deleteExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                               com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                               com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtData,
                               com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                        throws LayoutException

This method will delete the extended data for this widget.

The superclass DefaultContentWidgetManager will be called to delete the default content.

Specified by:

deleteExtendedData in interface WidgetManager

Overrides:

deleteExtendedData in class DefaultContentWidgetManager

Parameters:

aLayout - The layout object to which the widget belongs to.

aWidget - The widget where the extended data is being deleted.

aExtData - The extended data being deleted from the page layout.

aWidgetSDO - The physical data object object of the widget.

Throws:

LayoutException - This exception will be thrown if an error occurred when deleting the marketing default content.

See Also:

DefaultContentWidgetManager.deleteExtendedData(LayoutType, WidgetType, ExtendedDataType, PageLayoutWidget)

update

public void update(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                   com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                   com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
            throws LayoutException

This method performs no-operation. Subclasses should call this super method before implementing custom behavior.

Specified by:

update in interface WidgetManager

Overrides:

update in class DefaultWidgetManager

Parameters:

aLayout - The layout object to which the widget belongs to.

aWidget - The widget being updated on a page layout.

aWidgetSDO - The physical data object of the widget.

Throws:

LayoutException - This exception is to allow implementation classes to indicate its invoker about the error that occurred while persisting the widget.