com.liferay.portal.kernel.lar

Class DefaultConfigurationPortletDataHandler

java.lang.Object

com.liferay.portal.kernel.lar.BasePortletDataHandler

com.liferay.portal.kernel.lar.DefaultConfigurationPortletDataHandler

All Implemented Interfaces:

PortletDataHandler

public class DefaultConfigurationPortletDataHandler
extends BasePortletDataHandler

Author:

Eduardo Garcia

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurationPortletDataHandler()

Method Summary

Methods

Modifier and Type	Method and Description
javax.portlet.PortletPreferences	deleteData(PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences) Deletes the data created by the portlet.
java.lang.String	exportData(PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences) Returns a string of data to be placed in the <portlet-data> section of the LAR file.
long	getExportModelCount(ManifestSummary manifestSummary)
javax.portlet.PortletPreferences	importData(PortletDataContext portletDataContext, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences, java.lang.String data) Handles any special processing of the data when the portlet is imported into a new layout.

Methods inherited from class com.liferay.portal.kernel.lar.BasePortletDataHandler

addExportDataRootElement, addImportDataRootElement, addUncheckedModelAdditionCount, doDeleteData, doExportData, doImportData, doPrepareManifestSummary, doProcessExportPortletPreferences, doProcessImportPortletPreferences, getDataLevel, getDataPortletPreferences, getDeletionSystemEventStagedModelTypes, getDisplayTemplate, getDisplayTemplateGroupId, getExportConfigurationControls, getExportConfigurationControls, getExportControls, getExportDataRootElementString, getExportMetadataControls, getExportModelCount, getImportConfigurationControls, getImportConfigurationControls, getImportControls, getImportMetadataControls, getPortletId, isDataLocalized, isDataPortalLevel, isDataPortletInstanceLevel, isDataSiteLevel, isDisplayPortlet, isPublishToLiveByDefault, isSupportsDataStrategyCopyAsNew, prepareManifestSummary, prepareManifestSummary, processExportPortletPreferences, processImportPortletPreferences, setAlwaysExportable, setAlwaysStaged, setDataLevel, setDataLocalized, setDataPortletPreferences, setDeletionSystemEventStagedModelTypes, setExportControls, setExportMetadataControls, setImportControls, setImportMetadataControls, setPortletId, setPublishToLiveByDefault, setSupportsDataStrategyCopyAsNew

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultConfigurationPortletDataHandler

public DefaultConfigurationPortletDataHandler()

Method Detail

deleteData

public javax.portlet.PortletPreferences deleteData(PortletDataContext portletDataContext,
                                          java.lang.String portletId,
                                          javax.portlet.PortletPreferences portletPreferences)

Description copied from interface: PortletDataHandler

Deletes the data created by the portlet. Can optionally return a modified version of preferences if it contains reference to data that does not exist anymore.

Specified by:

deleteData in interface PortletDataHandler

Overrides:

deleteData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data deletion

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

Returns:

A modified version of portlet preferences that should be saved. Null if the portlet preferences were unmodified by this data handler.

exportData

public java.lang.String exportData(PortletDataContext portletDataContext,
                          java.lang.String portletId,
                          javax.portlet.PortletPreferences portletPreferences)

Description copied from interface: PortletDataHandler

Returns a string of data to be placed in the <portlet-data> section of the LAR file. This data will be passed as the data parameter of importData().

Specified by:

exportData in interface PortletDataHandler

Overrides:

exportData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data export

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

Returns:

A string of data to be placed in the LAR. It may be XML, but not necessarily. Null should be returned if no portlet data is to be written out.

getExportModelCount

public long getExportModelCount(ManifestSummary manifestSummary)

Specified by:

getExportModelCount in interface PortletDataHandler

Overrides:

getExportModelCount in class BasePortletDataHandler

importData

public javax.portlet.PortletPreferences importData(PortletDataContext portletDataContext,
                                          java.lang.String portletId,
                                          javax.portlet.PortletPreferences portletPreferences,
                                          java.lang.String data)

Description copied from interface: PortletDataHandler

Handles any special processing of the data when the portlet is imported into a new layout. Can optionally return a modified version of preferences to be saved in the new portlet.

Specified by:

importData in interface PortletDataHandler

Overrides:

importData in class BasePortletDataHandler

Parameters:

portletDataContext - the context of the data import

portletId - the portlet ID of the portlet

portletPreferences - the portlet preferences of the portlet

data - the string data that was returned by exportData()

Returns:

A modified version of portlet preferences that should be saved. Null if the portlet preferences were unmodified by this data handler.