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

Class RichTextWidgetManager

  • All Implemented Interfaces:
    WidgetManager


    public class RichTextWidgetManager
    extends MarketingWidgetManager

    This is the widget manager generates marketing content for the rich text widget page composer widget.

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

    See Also:
    DefaultWidgetManager
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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 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 Objects 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 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.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RichTextWidgetManager

        public RichTextWidgetManager()
    • 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 DefaultWidgetManager will be called to create default content associated to this widget.

        Specified by:
        createExtendedData in interface WidgetManager
        Overrides:
        createExtendedData in class MarketingWidgetManager
        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 creating the marketing content.
        See Also:
        DefaultWidgetManager.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 DefaultWidgetManager will be called to retrieve the espots associated with this widget.

        Specified by:
        retrieveExtendedData in interface WidgetManager
        Overrides:
        retrieveExtendedData in class MarketingWidgetManager
        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 marketing content.
        See Also:
        com.ibm.commerce.pagelayout.widget.management.impl.DefaultWidgetManager#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 DefaultWidgetManager will be called to update the marketing content.

        Specified by:
        updateExtendedData in interface WidgetManager
        Overrides:
        updateExtendedData in class MarketingWidgetManager
        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)
      • 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 Objects for this Widget.
        Specified by:
        delete in interface WidgetManager
        Overrides:
        delete in class MarketingWidgetManager
        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.
        See Also:
        DefaultWidgetManager.delete(LayoutType, WidgetType, PageLayoutWidget)