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

Class ProductListingWidgetManager

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

All Implemented Interfaces:

WidgetManager

public class ProductListingWidgetManager
extends DefaultContentWidgetManager

This is the widget manager associates default marketing content for the product listing 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.

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

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 aWidgetSDO, java.lang.Integer[] storePath, java.lang.Integer[] languageIds, SelectionCriteria criteria, java.lang.Object... parameters) This method will retrieve extended data for this widget.
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 will check if the check box has been de-selected to "add content to the catalog entry list".
void	updateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType extData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method will update extended data for this widget.
java.util.List<ClientError>	validateChangeExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType extendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method will perform validation on the associated default content to this marketing spot of the widget.
java.util.List<ClientError>	validateCreateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType extendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO) This method will perform validation on the associated default content to this marketing spot of the widget.

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, validateCreate, validateDelete, validateDeleteExtendedData

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductListingWidgetManager

public ProductListingWidgetManager()

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 aWidgetSDO,
                                 java.lang.Integer[] storePath,
                                 java.lang.Integer[] languageIds,
                                 SelectionCriteria criteria,
                                 java.lang.Object... parameters)
                          throws LayoutException

This method will retrieve extended data for this widget.

The superclass DefaultContentWidgetManager will be called to retrieve the default content associated with this widget.

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.

aWidgetSDO - The physical data object 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 an error occurs while retrieving the default content.

See Also:

com.ibm.commerce.pagelayout.widget.management.impl.DefaultContentWidgetManager#retrieveExtendedData(LayoutType, WidgetType, Integer[], Integer[], SelectionCriteria, Object...)

updateExtendedData

public void updateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout,
                               com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget,
                               com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType extData,
                               com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                        throws LayoutException

This method will update extended data for this widget.

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

Specified by:

updateExtendedData in interface WidgetManager

Overrides:

updateExtendedData in class DefaultContentWidgetManager

Parameters:

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

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

extData - The extended data being updated 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.

See Also:

DefaultWidgetManager.updateExtendedData(LayoutType, WidgetType, ExtendedDataType, PageLayoutWidget)

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)

validateChangeExtendedData

public java.util.List<ClientError> validateChangeExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout,
                                                              com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget,
                                                              com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType extendedData,
                                                              com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                                                       throws LayoutException

This method will perform validation on the associated default content to this marketing spot of the widget.

Specified by:

validateChangeExtendedData in interface WidgetManager

Overrides:

validateChangeExtendedData in class DefaultWidgetManager

Parameters:

layout - The layout from the request

widget - The widget from the request

extendedData - The extended data of the widger from the request

aWidgetSDO - The physical SDO of the widget

Returns:

A list of client errors that indicate validation errors. Null, if there are no errors.

Throws:

LayoutException

See Also:

com.ibm.commerce.pagelayout.widget.management.spi.WidgetManager#validateChangeExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType)

validateCreateExtendedData

public java.util.List<ClientError> validateCreateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType layout,
                                                              com.ibm.commerce.pagelayout.facade.datatypes.WidgetType widget,
                                                              com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType extendedData,
                                                              com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                                                       throws LayoutException

This method will perform validation on the associated default content to this marketing spot of the widget.

Specified by:

validateCreateExtendedData in interface WidgetManager

Overrides:

validateCreateExtendedData in class DefaultWidgetManager

Parameters:

layout - The layout from the request

widget - The widget from the request

extendedData - The extended data of the widger from the request

aWidgetSDO - The physical SDO of the widget

Returns:

A list of client errors that indicate validation errors. Null, if there are no errors.

Throws:

LayoutException

See Also:

com.ibm.commerce.pagelayout.widget.management.spi.WidgetManager#validateCreateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType)

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 will check if the check box has been de-selected to "add content to the catalog entry list".

If so, the default content associated with this widget's marketing spot will be removed.

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.