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
- Direct Known Subclasses:
- AssetCategoriesNavigationPortletDataHandler, AssetPublisherPortletDataHandler, BlogsAggregatorPortletDataHandler
public class DefaultConfigurationPortletDataHandler
- extends BasePortletDataHandler
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 |
DefaultConfigurationPortletDataHandler
public DefaultConfigurationPortletDataHandler()
deleteData
public PortletPreferences deleteData(PortletDataContext portletDataContext,
String portletId,
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 deletionportletId
- the portlet ID of the portletportletPreferences
- 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 String exportData(PortletDataContext portletDataContext,
String portletId,
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 exportportletId
- the portlet ID of the portletportletPreferences
- 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 PortletPreferences importData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences,
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 importportletId
- the portlet ID of the portletportletPreferences
- the portlet preferences of the portletdata
- 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.