com.ibm.commerce.pagelayout.widget.management

Class WidgetManagerFactory

java.lang.Object

com.ibm.commerce.pagelayout.widget.management.WidgetManagerFactory

public class WidgetManagerFactory
extends java.lang.Object

This factory is used to create instances of the widget manager based on the widget definition unique ID or the widget identifier or the unique ID of the widget specified.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT Copyright field.
static WidgetManagerFactory	SINGLETON The singleton instance of the factory.

Method Summary

Modifier and Type	Method and Description
WidgetManager	getWidgetManager(java.lang.String widgetDefinitionUniqueId) This method retrieves the widget manager for the widget definition based on the specified widget definition unique ID in current store.
WidgetManager	getWidgetManager(java.lang.String widgeDefinitiontIdentifier, java.lang.Integer storeId) This method retrieves the widget manager for the widget definition based on the widget definition's identifier and store Id specified.
WidgetManager	getWidgetManagerByWidgetDefinitionUniqueId(java.lang.String widgetDefinitionUniqueId, java.lang.Integer storeId) This method retrieves the widget manager for the widget definition based on the widget definition unique ID on the page layout for the specified store.
WidgetManager	getWidgetManagerByWidgetUniqueId(java.lang.String widgetId, java.lang.Integer storeId) This method retrieves the widget manager for the widget definition based on the unique ID of the widget placed on the page layout for the 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

Copyright field.

See Also:

Constant Field Values

SINGLETON

public static WidgetManagerFactory SINGLETON

The singleton instance of the factory.

Method Detail

getWidgetManager

public WidgetManager getWidgetManager(java.lang.String widgetDefinitionUniqueId)
                               throws WidgetDefinitionException

This method retrieves the widget manager for the widget definition based on the specified widget definition unique ID in current store.

Parameters:

widgetDefinitionUniqueId - The unique ID of the widget definition

Returns:

The widget manager class.

Throws:

WidgetDefinitionException - This exception is thrown when the widget definition could not be found.

getWidgetManager

public WidgetManager getWidgetManager(java.lang.String widgeDefinitiontIdentifier,
                                      java.lang.Integer storeId)
                               throws WidgetDefinitionException

This method retrieves the widget manager for the widget definition based on the widget definition's identifier and store Id specified.

Parameters:

widgeDefinitiontIdentifier - The unique Identifier for the widget.

storeId - The store Id of the widget.

Returns:

The widget manager class.

Throws:

WidgetDefinitionException - This exception is thrown when the widget definition could not found.

getWidgetManagerByWidgetUniqueId

public WidgetManager getWidgetManagerByWidgetUniqueId(java.lang.String widgetId,
                                                      java.lang.Integer storeId)
                                               throws WidgetDefinitionException

This method retrieves the widget manager for the widget definition based on the unique ID of the widget placed on the page layout for the specified store.

Parameters:

widgetId - The unique ID of the widget on the page layout.

storeId - The unique id of the store

Returns:

The widget manager class.

Throws:

WidgetDefinitionException - This exception is thrown when the widget could not be found.

getWidgetManagerByWidgetDefinitionUniqueId

public WidgetManager getWidgetManagerByWidgetDefinitionUniqueId(java.lang.String widgetDefinitionUniqueId,
                                                                java.lang.Integer storeId)
                                                         throws WidgetDefinitionException

This method retrieves the widget manager for the widget definition based on the widget definition unique ID on the page layout for the specified store.

Parameters:

widgetDefinitionUniqueId - The unique ID of the widget definition

storeId - The unique id of the store

Returns:

The widget manager class.

Throws:

WidgetDefinitionException - This exception is thrown when the widget definition could not be found.