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

Class MarketingWidgetManager

java.lang.Object

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

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

All Implemented Interfaces:

WidgetManager

Direct Known Subclasses:

DefaultContentWidgetManager, IBMProductRecommendationsWidgetManager, RichTextWidgetManager, URLLinkWidgetManager

public class MarketingWidgetManager
extends DefaultWidgetManager

This is the base widget manager for all widget managers which implements using marketing objects. It provides common functions like create corresponding marketing e-spot for widget and persistent widget display title.

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
MarketingWidgetManager()

Method Summary

Modifier and Type	Method and Description
void	create(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget) This method creates E-Marketing spot for widget if requireEMS widget property is set to true.
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 aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method creates the widget display title if display title extended data is passed in.
void	delete(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 deletes the corresponding marketing spot of the widget if requireEMS property of the widget is set to true.
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 aextendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method deletes the extended data which is common to all widgets with marketing implementation.
void	retrieveExtendedData(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, java.lang.Integer[] aStorePath, java.lang.Integer[] aLanguageIds, SelectionCriteria aCriteria, java.lang.Object... parameters) This methods retrieves display title extended data.
void	undo(com.ibm.commerce.foundation.internal.server.services.changehistory.beans.TaskGroupChangeHistoryDataSet tgchDataSet, java.lang.String widgetId, LayoutManagementResourceManager layoutResourceManager) This method is called when undo is invoked.
void	updateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method updates the widget display title extended data.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MarketingWidgetManager

public MarketingWidgetManager()

Method Detail

create

public void create(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                   com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget)
            throws LayoutException

This method creates E-Marketing spot for widget if requireEMS widget property is set to true. Subclasses should call this super method before implementing custom behavior.

Specified by:

create in interface WidgetManager

Overrides:

create in class DefaultWidgetManager

Parameters:

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

aWidget - The widget being removed from the page layout.

Throws:

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

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 aExtendedData,
                               com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                        throws LayoutException

This method creates the widget display title if display title extended data is passed in. Subclasses should call this super method before implementing custom behavior. It creates the widget display title.

Specified by:

createExtendedData in interface WidgetManager

Overrides:

createExtendedData in class DefaultWidgetManager

Parameters:

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

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

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

aWidgetSDO - The physical data object object of the widget.

Throws:

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

updateExtendedData

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

This method updates the widget display title extended data. Subclasses should call this super method before implementing custom behavior. It updates the widget display title.

Specified by:

updateExtendedData in interface WidgetManager

Overrides:

updateExtendedData in class DefaultWidgetManager

Parameters:

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

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

aExtendedData - The extended data being updated from the 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 deleting the widget.

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 aextendedData,
                               com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                        throws LayoutException

This method deletes the extended data which is common to all widgets with marketing implementation. Subclasses should call this super method before implementing custom behavior.

Specified by:

deleteExtendedData in interface WidgetManager

Overrides:

deleteExtendedData in class DefaultWidgetManager

Parameters:

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

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

aextendedData - The extended data being deleted from the 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 deleting the widget.

delete

public void delete(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 deletes the corresponding marketing spot of the widget if requireEMS property of the widget is set to true. Subclasses should call this super method before implementing custom behavior.

Specified by:

delete in interface WidgetManager

Overrides:

delete in class DefaultWidgetManager

Parameters:

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

aWidget - The widget being removed from the 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 deleting the widget.

retrieveExtendedData

public void retrieveExtendedData(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,
                                 java.lang.Integer[] aStorePath,
                                 java.lang.Integer[] aLanguageIds,
                                 SelectionCriteria aCriteria,
                                 java.lang.Object... parameters)
                          throws LayoutException

This methods retrieves display title extended data. Subclasses should call this super method before implementing custom behavior.

Specified by:

retrieveExtendedData in interface WidgetManager

Overrides:

retrieveExtendedData in class DefaultWidgetManager

Parameters:

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

aWidget - The widget object that needs to be populated.

aWidgetSDO - The physical data object of the widget.

aStorePath - The store path of the request.

aLanguageIds - The requested language ids.

aCriteria - 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.

undo

public void undo(com.ibm.commerce.foundation.internal.server.services.changehistory.beans.TaskGroupChangeHistoryDataSet tgchDataSet,
                 java.lang.String widgetId,
                 LayoutManagementResourceManager layoutResourceManager)
          throws LayoutException

This method is called when undo is invoked.

Specified by:

undo in interface WidgetManager

Overrides:

undo in class DefaultWidgetManager

Parameters:

tgchDataSet - The change history record

widgetId - The widget id

layoutResourceManager - The Layout Resource Manager

Throws:

LayoutException - If there is an error. This should be raised if all undo actions performed by the underlying infrastructure should be rolled back.