com.ibm.commerce.pagelayout.widget.management

Class J2EEWidgetManagerSource

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright field.
    • Method Summary

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

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

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • J2EEWidgetManagerSource

        public J2EEWidgetManagerSource()
    • Method Detail

      • getWidgetManager

        public WidgetManager getWidgetManager(java.lang.String widgetDefinitionUniqueID)
                                       throws WidgetDefinitionException
        Description copied from interface: WidgetManagerSource
        This method retrieves the widget manager class based on the unique ID of the widget definition in current store.
        Specified by:
        getWidgetManager in interface WidgetManagerSource
        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

        public WidgetManager getWidgetManager(java.lang.String widgetDefinitionIdentifier,
                                              java.lang.Integer storeId)
                                       throws WidgetDefinitionException
        Description copied from interface: WidgetManagerSource
        This method retrieves the widget manager class based on the widget definition's identifier and store specified.
        Specified by:
        getWidgetManager in interface WidgetManagerSource
        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

        public WidgetManager getWidgetManagerByWidgetUniqueId(java.lang.String widgetId,
                                                              java.lang.Integer storeId)
                                                       throws WidgetDefinitionException
        Description copied from interface: WidgetManagerSource
        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.
        Specified by:
        getWidgetManagerByWidgetUniqueId in interface WidgetManagerSource
        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

        public WidgetManager getWidgetManagerByWidgetDefinitionUniqueId(java.lang.String widgetDefinitionUniqueId,
                                                                        java.lang.Integer storeId)
                                                                 throws WidgetDefinitionException
        Description copied from interface: WidgetManagerSource
        This method retrieves the widget manager class based on the unique ID of the widget definition on a page layout in the specified store.
        Specified by:
        getWidgetManagerByWidgetDefinitionUniqueId in interface WidgetManagerSource
        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.