WidgetManager

All Known Implementing Classes:

CategoryRecommendationWidgetManager, ContentRecommendationWidgetManager, DefaultContentAndWebActivityWidgetManager, DefaultContentWidgetManager, DefaultWidgetManager, IBMProductRecommendationsWidgetManager, MarketingWidgetManager, ProductListingWidgetManager, ProductRecommendationWidgetManager, RichTextWidgetManager, RotatingContentWidgetManager, URLLinkWidgetManager
```
public interface WidgetManager
```
This interface represents a widget manager. Every widget definition can provide an implementation for this interface and register the same in their XML definition. A widget manager is responsible for handling the persistence and retrieval of a widget that is placed on a page layout.
A widget manager operates in two execution environments. The J2EE execution environment represents the execution of the widget manager in the same JVM as the WebSphere Commerce application. The J2SE execution environment represents the execution of the widget manager on a JVM separate from the WebSphere Commerce application. This typically happens in the context of data load being executed through the command line utility. The widget manager is aware of its current execution environment and can choose different code flow paths accordingly. Each widget can alternately register two different widget managers based on the execution environment.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` Copyright field.
`static java.lang.String`	`CURRENT_ENVIRONMENT` Constant representing the current execution environment.
`static java.lang.String`	`EXECUTION_TYPE_J2EE` Constant representing the J2EE execution environment.
`static java.lang.String`	`EXECUTION_TYPE_J2SE` Constant representing the J2SE execution environment.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`create(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget)` This method persists the widget information when a widget is being added to a page layout.
`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 aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)` This method persists the widget extended data when a extended data is being added to a 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 widget information when a widget is being removed from a page layout.
`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 aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)` This method deletes the widget extended data when a extended data is being removed from a widget.
`com.ibm.commerce.pagelayout.facade.datatypes.WidgetDefinitionType`	`getWidgetDefinition()` Returns the logical widget definition data object for this widget.
`void`	`init(com.ibm.commerce.pagelayout.facade.datatypes.WidgetDefinitionType widgetDefinition)` This method initializes the widget manager with the widget definition that uses it.
`void`	`retrieve(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, java.lang.Object... parameters)` This method is used to populate the widget object when the page layout is being retrieved in a service request.
`void`	`retrieve(com.ibm.commerce.pagelayout.facade.datatypes.PageDesignType aPageDesign, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, java.lang.Object... parameters)` This method is used to populate the widget object when the page layout is being retrieved in a service request.
`void`	`retrieveExtendedData(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, java.lang.Integer[] aStorePath, java.lang.Integer[] aLanguageIds, SelectionCriteria aCriteria, java.lang.Object... parameters)` This method is used to populate the extended data of widget object when the page layout is being retrieved in a service request.
`void`	`undo(com.ibm.commerce.foundation.internal.server.services.changehistory.beans.TaskGroupChangeHistoryDataSet tgchDataSet, java.lang.String widgetId, LayoutManagementResourceManager layoutResourceManager)` This method is called when undo is invoked.
`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 persists the widget information when a widget is being updated on a page layout.
`void`	`updateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)` This method persists the widget extended data when a extended data is being updated on a widget.
`java.util.List<ClientError>`	`validateChange(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 validates the widget information when the widget is being updated on a page layout.
`java.util.List<ClientError>`	`validateChangeExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)` This method validates the extended data information when the extended data is being updated on a widget.
`java.util.List<ClientError>`	`validateCreate(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget)` This method validates the widget information when the widget is being added to a page layout.
`java.util.List<ClientError>`	`validateCreateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)` This method validates the extended data information when the extended data is being added to a widget.
`java.util.List<ClientError>`	`validateDelete(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 validates the widget information when the widget is being deleted from a page layout.
`java.util.List<ClientError>`	`validateDeleteExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout, com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget, com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData, com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)` This method validates the extended data information when the extended data is being deleted from a widget.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    Copyright field.
    
    See Also:
    
    Constant Field Values
  - EXECUTION_TYPE_J2EE
```
static final java.lang.String EXECUTION_TYPE_J2EE
```
    Constant representing the J2EE execution environment.
    
    See Also:
    
    Constant Field Values
  - EXECUTION_TYPE_J2SE
```
static final java.lang.String EXECUTION_TYPE_J2SE
```
    Constant representing the J2SE execution environment.
    
    See Also:
    
    Constant Field Values
  - CURRENT_ENVIRONMENT
```
static final java.lang.String CURRENT_ENVIRONMENT
```
    Constant representing the current execution environment.
- Method Detail
  - getWidgetDefinition
```
com.ibm.commerce.pagelayout.facade.datatypes.WidgetDefinitionType getWidgetDefinition()
```
    Returns the logical widget definition data object for this widget.
    
    Returns:
    
    The logical widget definition data object for this widget
  - validateCreate
```
java.util.List<ClientError> validateCreate(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                                           com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget)
                                    throws LayoutException
```
    This method validates the widget information when the widget is being added to a page layout.
    
    Parameters:
    
    aLayout - The layout object to which the widget is being added.
    
    aWidget - The widget being added to the page layout.
    
    Returns:
    
    A list of client errors that indicate validation errors. Null, if there are no errors.
    
    Throws:
    
    LayoutException - This exception is to provide the implementation classes the convenience of throwing an exception instead of returning a list of application errors.
  - validateCreateExtendedData
```
java.util.List<ClientError> validateCreateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                                                       com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                                                       com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData,
                                                       com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                                                throws LayoutException
```
    This method validates the extended data information when the extended data is being added to a widget.
    
    Parameters:
    
    aLayout - The layout object to which the widget is being updated.
    
    aWidget - The widget where the extended data is being created.
    
    aExtendedData - The extended data being added to the widget.
    
    aWidgetSDO - The physical data object object of the widget.
    
    Returns:
    
    A list of client errors that indicate validation errors. Null, if there are no errors.
    
    Throws:
    
    LayoutException - This exception is to provide the implementation classes the convenience of throwing an exception instead of returning a list of application errors.
  - validateChange
```
java.util.List<ClientError> validateChange(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 validates the widget information when the widget is being updated on a page layout.
    
    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 object of the widget.
    
    Returns:
    
    A list of client errors that indicate validation errors. Null, if there are no errors.
    
    Throws:
    
    LayoutException - This exception is to provide the implementation classes the convenience of throwing an exception instead of returning a list of application errors.
  - validateChangeExtendedData
```
java.util.List<ClientError> validateChangeExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                                                       com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                                                       com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData,
                                                       com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                                                throws LayoutException
```
    This method validates the extended data information when the extended data is being updated on a widget.
    
    Parameters:
    
    aLayout - The layout object to which the widget is being updated.
    
    aWidget - The widget where the extended data is being updated.
    
    aExtendedData - The extended data being updated on the widget.
    
    aWidgetSDO - The physical data object object of the widget.
    
    Returns:
    
    A list of client errors that indicate validation errors. Null, if there are no errors.
    
    Throws:
    
    LayoutException - This exception is to provide the implementation classes the convenience of throwing an exception instead of returning a list of application errors.
  - validateDelete
```
java.util.List<ClientError> validateDelete(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 validates the widget information when the widget is being deleted from a page layout.
    
    Parameters:
    
    aLayout - The layout object to which the widget belongs to.
    
    aWidget - The widget being deleted from a page layout.
    
    aWidgetSDO - The physical data object object of the widget.
    
    Returns:
    
    A list of client errors that indicate validation errors. Null, if there are no errors.
    
    Throws:
    
    LayoutException - This exception is to provide the implementation classes the convenience of throwing an exception instead of returning a list of application errors.
  - validateDeleteExtendedData
```
java.util.List<ClientError> validateDeleteExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                                                       com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                                                       com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData,
                                                       com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                                                throws LayoutException
```
    This method validates the extended data information when the extended data is being deleted from a widget.
    
    Parameters:
    
    aLayout - The layout object to which the widget is being upated.
    
    aWidget - The widget where the extended data is being deleted.
    
    aExtendedData - The extended data being deleted from the widget.
    
    aWidgetSDO - The physical data object object of the widget.
    
    Returns:
    
    A list of client errors that indicate validation errors. Null, if there are no errors.
    
    Throws:
    
    LayoutException - This exception is to provide the implementation classes the convenience of throwing an exception instead of returning a list of application errors.
  - create
```
void create(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
            com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget)
     throws LayoutException
```
    This method persists the widget information when a widget is being added to a page layout.
    
    Parameters:
    
    aLayout - The layout object in which the widget is being created.
    
    aWidget - The widget being added to the page layout.
    
    Throws:
    
    LayoutException - This exception is to allow implementation classes to indicate its invoker about the error that occurred while persisting the widget.
  - createExtendedData
```
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 aExtendedData,
                        com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                 throws LayoutException
```
    This method persists the widget extended data when a extended data is being added to a widget.
    
    Parameters:
    
    aLayout - The layout object to which the widget belongs to.
    
    aWidget - The widget where the extended data is being created.
    
    aExtendedData - The extended data being created 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.
  - update
```
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 persists the widget information when a widget is being updated on a page layout.
    
    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 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.
  - updateExtendedData
```
void updateExtendedData(com.ibm.commerce.pagelayout.facade.datatypes.LayoutType aLayout,
                        com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
                        com.ibm.commerce.pagelayout.facade.datatypes.ExtendedDataType aExtendedData,
                        com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                 throws LayoutException
```
    This method persists the widget extended data when a extended data is being updated on a widget.
    
    Parameters:
    
    aLayout - The layout object to which the widget belongs to.
    
    aWidget - The widget where the extended data is being updated.
    
    aExtendedData - The extended data being created 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.
  - delete
```
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 widget information when a widget is being removed from a page layout.
    
    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 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.
  - deleteExtendedData
```
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 aExtendedData,
                        com.ibm.commerce.pagelayout.facade.server.entity.datatypes.PageLayoutWidget aWidgetSDO)
                 throws LayoutException
```
    This method deletes the widget extended data when a extended data is being removed from a widget.
    
    Parameters:
    
    aLayout - The layout object to which the widget belongs to.
    
    aWidget - The widget where the extended data is being deleted.
    
    aExtendedData - The extended data being created 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.
  - retrieve
```
void retrieve(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,
              java.lang.Object... parameters)
       throws LayoutException
```
    This method is used to populate the widget object when the page layout is being retrieved in a service request.
    
    Parameters:
    
    aLayout - The layout object to which the widget belongs to.
    
    aWidget - The widget object that needs to be populated.
    
    aWidgetSDO - The physical data object object of the widget.
    
    parameters - This list would contain the selection criteria object.
    
    Throws:
    
    LayoutException - This exception is to allow implementation classes to indicate its invoker about the error that occurred while retrieving the widget information.
  - retrieveExtendedData
```
void retrieveExtendedData(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,
                          java.lang.Integer[] aStorePath,
                          java.lang.Integer[] aLanguageIds,
                          SelectionCriteria aCriteria,
                          java.lang.Object... parameters)
                   throws LayoutException
```
    This method is used to populate the extended data of widget object when the page layout is being retrieved in a service request.
    
    Parameters:
    
    aLayout - The layout object to which the widget belongs to.
    
    aWidget - The widget object that needs to be populated.
    
    aWidgetSDO - The physical data object object of the widget.
    
    aStorePath - The store path of the request.
    
    aLanguageIds - The requested language ids.
    
    aCriteria - The selection criteria of the request.
    
    parameters - This list would contain the selection criteria object.
    
    Throws:
    
    LayoutException - This exception is to allow implementation classes to indicate its invoker about the error that occurred while retrieving the widget information.
  - retrieve
```
void retrieve(com.ibm.commerce.pagelayout.facade.datatypes.PageDesignType aPageDesign,
              com.ibm.commerce.pagelayout.facade.datatypes.WidgetType aWidget,
              java.lang.Object... parameters)
       throws PageDesignException
```
    This method is used to populate the widget object when the page layout is being retrieved in a service request.
    
    Parameters:
    
    aPageDesign - The page design object to which the widget belongs to.
    
    aWidget - The widget object that needs to be populated.
    
    parameters - This list would contain the selection criteria object.
    
    Throws:
    
    PageDesignException - This exception is to allow implementation classes to indicate its invoker about the error that occurred while retrieving the widget information.
  - init
```
void init(com.ibm.commerce.pagelayout.facade.datatypes.WidgetDefinitionType widgetDefinition)
```
    This method initializes the widget manager with the widget definition that uses it.
    
    Parameters:
    
    widgetDefinition - The widget definition object
  - undo
```
void undo(com.ibm.commerce.foundation.internal.server.services.changehistory.beans.TaskGroupChangeHistoryDataSet tgchDataSet,
          java.lang.String widgetId,
          LayoutManagementResourceManager layoutResourceManager)
   throws LayoutException
```
    This method is called when undo is invoked.
    
    Parameters:
    
    tgchDataSet - The change history record
    
    widgetId - The widget id
    
    layoutResourceManager - The Layout Resource Manager
    
    Throws:
    
    LayoutException - If there is an error. This should be raised if all undo actions performed by the underlying infrastructure should be rolled back.

COPYRIGHT

EXECUTION_TYPE_J2EE

EXECUTION_TYPE_J2SE

CURRENT_ENVIRONMENT

getWidgetDefinition

validateCreate

validateCreateExtendedData

validateChange

validateChangeExtendedData

validateDelete

validateDeleteExtendedData

create

createExtendedData

update

updateExtendedData

delete

deleteExtendedData

retrieve

retrieveExtendedData

retrieve

init

undo