public interface WidgetManager
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.
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.
|
Modifier and Type | Method and Description |
---|---|
void | create(LayoutType aLayout, WidgetType aWidget)
This method persists the widget information when a widget is being added to a page layout.
|
void | createExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO)
This method persists the widget extended data when a extended data is being added to a widget.
|
void | delete(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO)
This method deletes the widget information when a widget is being removed from a page layout.
|
void | deleteExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO)
This method deletes the widget extended data when a extended data is being removed from a widget.
|
WidgetDefinitionType | getWidgetDefinition()
Returns the logical widget definition data object for this widget.
|
void | init(WidgetDefinitionType widgetDefinition)
This method initializes the widget manager with the widget definition that uses it.
|
void | retrieve(LayoutType aLayout, WidgetType aWidget, 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(PageDesignType aPageDesign, 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(LayoutType aLayout, WidgetType aWidget, 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(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO)
This method persists the widget information when a widget is being updated on a page layout.
|
void | updateExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO)
This method persists the widget extended data when a extended data is being updated on a widget.
|
java.util.List<ClientError> | validateChange(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO)
This method validates the widget information when the widget is being updated on a page layout.
|
java.util.List<ClientError> | validateChangeExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO)
This method validates the extended data information when the extended data is being updated on a widget.
|
java.util.List<ClientError> | validateCreate(LayoutType aLayout, WidgetType aWidget)
This method validates the widget information when the widget is being added to a page layout.
|
java.util.List<ClientError> | validateCreateExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO)
This method validates the extended data information when the extended data is being added to a widget.
|
java.util.List<ClientError> | validateDelete(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO)
This method validates the widget information when the widget is being deleted from a page layout.
|
java.util.List<ClientError> | validateDeleteExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO)
This method validates the extended data information when the extended data is being deleted from a widget.
|
static final java.lang.String COPYRIGHT
static final java.lang.String EXECUTION_TYPE_J2EE
static final java.lang.String EXECUTION_TYPE_J2SE
static final java.lang.String CURRENT_ENVIRONMENT
WidgetDefinitionType getWidgetDefinition()
java.util.List<ClientError> validateCreate(LayoutType aLayout, WidgetType aWidget) throws LayoutException
java.util.List<ClientError> validateCreateExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO) throws LayoutException
java.util.List<ClientError> validateChange(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO) throws LayoutException
java.util.List<ClientError> validateChangeExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO) throws LayoutException
java.util.List<ClientError> validateDelete(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO) throws LayoutException
java.util.List<ClientError> validateDeleteExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO) throws LayoutException
void create(LayoutType aLayout, WidgetType aWidget) throws LayoutException
void createExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO) throws LayoutException
void update(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO) throws LayoutException
void updateExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO) throws LayoutException
void delete(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO) throws LayoutException
void deleteExtendedData(LayoutType aLayout, WidgetType aWidget, ExtendedDataType aExtendedData, PageLayoutWidget aWidgetSDO) throws LayoutException
void retrieve(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO, java.lang.Object... parameters) throws LayoutException
void retrieveExtendedData(LayoutType aLayout, WidgetType aWidget, PageLayoutWidget aWidgetSDO, java.lang.Integer[] aStorePath, java.lang.Integer[] aLanguageIds, SelectionCriteria aCriteria, java.lang.Object... parameters) throws LayoutException
void retrieve(PageDesignType aPageDesign, WidgetType aWidget, java.lang.Object... parameters) throws PageDesignException
void init(WidgetDefinitionType widgetDefinition)
void undo(com.ibm.commerce.foundation.internal.server.services.changehistory.beans.TaskGroupChangeHistoryDataSet tgchDataSet, java.lang.String widgetId, LayoutManagementResourceManager layoutResourceManager) throws LayoutException