Liferay 7.0-ce-b4

com.liferay.portlet.exportimport.lar
Class DefaultConfigurationPortletDataHandler

java.lang.Object
  extended by com.liferay.portlet.exportimport.lar.BasePortletDataHandler
      extended by com.liferay.portlet.exportimport.lar.DefaultConfigurationPortletDataHandler
All Implemented Interfaces:
PortletDataHandler

public class DefaultConfigurationPortletDataHandler
extends BasePortletDataHandler


Constructor Summary
DefaultConfigurationPortletDataHandler()
           
 
Method Summary
 PortletPreferences deleteData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences)
          Deletes the data created by the portlet.
 String exportData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences)
          Returns a string of data to be placed in the <portlet-data> section of the LAR file.
 long getExportModelCount(ManifestSummary manifestSummary)
          Returns the number of entities defined for this data handler that are available for export according to the provided manifest summary, or -1 if no entities are included in the manifest summary.
protected  String getExportPortletPreferencesUuid(PortletDataContext portletDataContext, Portlet portlet, String className, long primaryKeyLong)
           
protected  Long getImportPortletPreferencesNewPrimaryKey(PortletDataContext portletDataContext, Class<?> clazz, long companyGroupId, Map<Long,Long> primaryKeys, String uuid)
           
 PortletPreferences importData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences, String data)
          Handles any special processing of the data when the portlet is imported into a new layout.
protected  void updateExportPortletPreferencesClassPKs(PortletDataContext portletDataContext, Portlet portlet, PortletPreferences portletPreferences, String key, String className)
           
protected  void updateImportPortletPreferencesClassPKs(PortletDataContext portletDataContext, PortletPreferences portletPreferences, String key, Class<?> clazz, long companyGroupId)
           
 
Methods inherited from class com.liferay.portlet.exportimport.lar.BasePortletDataHandler
addDefaultData, addExportDataRootElement, addImportDataRootElement, addUncheckedModelAdditionCount, doAddDefaultData, doDeleteData, doExportData, doImportData, doPrepareManifestSummary, doProcessExportPortletPreferences, doProcessImportPortletPreferences, doValidateSchemaVersion, getDataLevel, getDataPortletPreferences, getDeletionSystemEventStagedModelTypes, getExportConfigurationControls, getExportConfigurationControls, getExportControls, getExportDataRootElementString, getExportMetadataControls, getExportModelCount, getImportConfigurationControls, getImportConfigurationControls, getImportControls, getImportMetadataControls, getPortletId, getRank, getSchemaVersion, getServiceName, isDataAlwaysStaged, isDataLocalized, isDataPortalLevel, isDataPortletInstanceLevel, isDataSiteLevel, isDisplayPortlet, isPublishToLiveByDefault, isRollbackOnException, isSupportsDataStrategyCopyAsNew, prepareManifestSummary, prepareManifestSummary, processExportPortletPreferences, processImportPortletPreferences, setAlwaysExportable, setAlwaysStaged, setDataAlwaysStaged, setDataLevel, setDataLocalized, setDataPortletPreferences, setDeletionSystemEventStagedModelTypes, setExportControls, setExportMetadataControls, setImportControls, setImportMetadataControls, setPortletId, setPublishToLiveByDefault, setRank, setSupportsDataStrategyCopyAsNew, validateSchemaVersion
 
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 PortletPreferences deleteData(PortletDataContext portletDataContext,
                                     String portletId,
                                     PortletPreferences portletPreferences)
Description copied from interface: PortletDataHandler
Deletes the data created by the portlet. It can optionally return a modified version of the portlet preferences if it contains references to data that no longer exists.

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 the portlet preferences that should be saved, or null if the data handler made no changes to the portlet preferences

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 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, which can be, but not limited to XML, or null if no portlet data is to be written out

getExportModelCount

public long getExportModelCount(ManifestSummary manifestSummary)
Description copied from interface: PortletDataHandler
Returns the number of entities defined for this data handler that are available for export according to the provided manifest summary, or -1 if no entities are included in the manifest summary.

Specified by:
getExportModelCount in interface PortletDataHandler
Overrides:
getExportModelCount in class BasePortletDataHandler
Parameters:
manifestSummary - the manifest summary listing the number of exportable entities
Returns:
the number of entities that are available for export according to the manifest summary, or -1 if no entities are included in the manifest summary

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 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 the portlet preferences that should be saved, or null if the data handler made no changes to the portlet preferences

getExportPortletPreferencesUuid

protected String getExportPortletPreferencesUuid(PortletDataContext portletDataContext,
                                                 Portlet portlet,
                                                 String className,
                                                 long primaryKeyLong)
                                          throws Exception
Throws:
Exception

getImportPortletPreferencesNewPrimaryKey

protected Long getImportPortletPreferencesNewPrimaryKey(PortletDataContext portletDataContext,
                                                        Class<?> clazz,
                                                        long companyGroupId,
                                                        Map<Long,Long> primaryKeys,
                                                        String uuid)
                                                 throws Exception
Throws:
Exception

updateExportPortletPreferencesClassPKs

protected void updateExportPortletPreferencesClassPKs(PortletDataContext portletDataContext,
                                                      Portlet portlet,
                                                      PortletPreferences portletPreferences,
                                                      String key,
                                                      String className)
                                               throws Exception
Throws:
Exception

updateImportPortletPreferencesClassPKs

protected void updateImportPortletPreferencesClassPKs(PortletDataContext portletDataContext,
                                                      PortletPreferences portletPreferences,
                                                      String key,
                                                      Class<?> clazz,
                                                      long companyGroupId)
                                               throws Exception
Throws:
Exception

Liferay 7.0-ce-b4