com.ibm.commerce.pagelayout.widget.management.spi

Interface WidgetManagerSource

  • All Known Implementing Classes:
    AbstractWidgetManagerSource, J2EEWidgetManagerSource

    public interface WidgetManagerSource
    The interface for the source of the widget manager configuration. The factory class of the widget manager will use this source implementation to retrieve the widget manager instance. The source implementation is chosen based on the current execution environment.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright field.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      WidgetManager getWidgetManager(java.lang.String widgetDefinitionUniqueId)
      This method retrieves the widget manager class based on the unique ID of the widget definition in current store.
      WidgetManager getWidgetManager(java.lang.String widgetDefinitionIdentifier, java.lang.Integer storeId)
      This method retrieves the widget manager class based on the widget definition's identifier and store specified.
      WidgetManager getWidgetManagerByWidgetDefinitionUniqueId(java.lang.String widgetDefinitionUniqueId, java.lang.Integer storeId)
      This method retrieves the widget manager class based on the unique ID of the widget definition on a page layout in the specified store.
      WidgetManager getWidgetManagerByWidgetUniqueId(java.lang.String widgetId, java.lang.Integer storeId)
      This method retrieves the widget manager class based on the unique ID of a widget on a page layout in specified store.

    • Method Detail

      • getWidgetManager

        WidgetManager getWidgetManager(java.lang.String widgetDefinitionUniqueId)
                        throws WidgetDefinitionException
        This method retrieves the widget manager class based on the unique ID of the widget definition in current store.
        Parameters:
        widgetDefinitionUniqueId - The unique ID of the widget definition.
        Returns:
        The widget manager instance.
        Throws:
        WidgetDefinitionException - This exception is thrown when the widget definition could not be found.

      • getWidgetManager

        WidgetManager getWidgetManager(java.lang.String widgetDefinitionIdentifier,
                               java.lang.Integer storeId)
                        throws WidgetDefinitionException
        This method retrieves the widget manager class based on the widget definition's identifier and store specified.
        Parameters:
        widgetDefinitionIdentifier - The widget definition's identifier.
        storeId - The store Id of the widget definition.
        Returns:
        The widget manager instance.
        Throws:
        WidgetDefinitionException - This exception is thrown when the widget definition could not be found.

      • getWidgetManagerByWidgetUniqueId

        WidgetManager getWidgetManagerByWidgetUniqueId(java.lang.String widgetId,
                                               java.lang.Integer storeId)
                                        throws WidgetDefinitionException
        This method retrieves the widget manager class based on the unique ID of a widget on a page layout in specified store. This method is a convenience method provided for scenarios when the widget definition for a layout widget is unknown.
        Parameters:
        widgetId - The unique ID of the widget placed on a page layout.
        storeId - The unique id of the store
        Returns:
        The widget manager class associated with it.
        Throws:
        WidgetDefinitionException - This exception is thrown when the widget definition could not be found.

      • getWidgetManagerByWidgetDefinitionUniqueId

        WidgetManager getWidgetManagerByWidgetDefinitionUniqueId(java.lang.String widgetDefinitionUniqueId,
                                                         java.lang.Integer storeId)
                                                  throws WidgetDefinitionException
        This method retrieves the widget manager class based on the unique ID of the widget definition on a page layout in the specified store.
        Parameters:
        widgetDefinitionUniqueId - The unique ID of the widget definition.
        storeId - The unique id of the store
        Returns:
        The widget manager class associated with it.
        Throws:
        WidgetDefinitionException - This exception is thrown when the widget definition could not be found.
Skip navigation links