com.liferay.portlet.documentlibrary.lar
Class DLDisplayPortletDataHandlerImpl

java.lang.Object
  com.liferay.portal.kernel.lar.BasePortletDataHandler
      com.liferay.portlet.documentlibrary.lar.DLDisplayPortletDataHandlerImpl

All Implemented Interfaces:

PortletDataHandler

public class DLDisplayPortletDataHandlerImpl
extends BasePortletDataHandler

Constructor Summary

DLDisplayPortletDataHandlerImpl()

Method Summary

protected PortletPreferences	doDeleteData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences)
protected String	doExportData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences)
protected PortletPreferences	doImportData(PortletDataContext portletDataContext, String portletId, PortletPreferences portletPreferences, String data)
String[]	getDataPortletPreferences() Returns an array of the portlet preferences that reference data.
PortletDataHandlerControl[]	getExportControls() Returns an array of the controls defined for this data handler.
PortletDataHandlerControl[]	getExportMetadataControls() Returns an array of the metadata controls defined for this data handler.
PortletDataHandlerControl[]	getImportControls() Returns an array of the controls defined for this data handler.
PortletDataHandlerControl[]	getImportMetadataControls() Returns an array of the metadata controls defined for this data handler.
boolean	isDataLocalized()
boolean	isPublishToLiveByDefault() Returns whether the data exported by this handler should be included by default when publishing to live.

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

deleteData, exportData, importData, isAlwaysExportable, isAlwaysStaged

Methods inherited from class java.lang.Object

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

Constructor Detail

DLDisplayPortletDataHandlerImpl

public DLDisplayPortletDataHandlerImpl()

Method Detail

getDataPortletPreferences

public String[] getDataPortletPreferences()

Description copied from interface: PortletDataHandler

Returns an array of the portlet preferences that reference data. These preferences should only be updated if the referenced data is imported.

Specified by:

getDataPortletPreferences in interface PortletDataHandler

Overrides:

getDataPortletPreferences in class BasePortletDataHandler

Returns:

A String array

getExportControls

public PortletDataHandlerControl[] getExportControls()

Description copied from interface: PortletDataHandler

Returns an array of the controls defined for this data handler. These controls enable the developer to create fine grained controls over export behavior. The controls are rendered in the export UI.

Specified by:

getExportControls in interface PortletDataHandler

Overrides:

getExportControls in class BasePortletDataHandler

Returns:

an array of PortletDataHandlerControls

getExportMetadataControls

public PortletDataHandlerControl[] getExportMetadataControls()

Description copied from interface: PortletDataHandler

Returns an array of the metadata controls defined for this data handler. These controls enable the developer to create fine grained controls over export behavior of metadata such as tags, categories, ratings or comments. The controls are rendered in the export UI.

Specified by:

getExportMetadataControls in interface PortletDataHandler

Overrides:

getExportMetadataControls in class BasePortletDataHandler

Returns:

an array of PortletDataHandlerControls

getImportControls

public PortletDataHandlerControl[] getImportControls()

Description copied from interface: PortletDataHandler

Returns an array of the controls defined for this data handler. These controls enable the developer to create fine grained controls over import behavior. The controls are rendered in the import UI.

Specified by:

getImportControls in interface PortletDataHandler

Overrides:

getImportControls in class BasePortletDataHandler

Returns:

An array of PortletDataHandlerControls

getImportMetadataControls

public PortletDataHandlerControl[] getImportMetadataControls()

Description copied from interface: PortletDataHandler

Returns an array of the metadata controls defined for this data handler. These controls enable the developer to create fine grained controls over import behavior of metadata such as tags, categories, ratings or comments. The controls are rendered in the export UI.

Specified by:

getImportMetadataControls in interface PortletDataHandler

Overrides:

getImportMetadataControls in class BasePortletDataHandler

Returns:

an array of PortletDataHandlerControls

isDataLocalized

public boolean isDataLocalized()

Specified by:

isDataLocalized in interface PortletDataHandler

Overrides:

isDataLocalized in class BasePortletDataHandler

isPublishToLiveByDefault

public boolean isPublishToLiveByDefault()

Description copied from interface: PortletDataHandler

Returns whether the data exported by this handler should be included by default when publishing to live. This should only be true for data that is meant to be managed in an staging environment such as CMS content, but not for data meant to be input by users such as wiki pages or message board posts.

Specified by:

isPublishToLiveByDefault in interface PortletDataHandler

Overrides:

isPublishToLiveByDefault in class BasePortletDataHandler

Returns:

true to publish to live by default

doDeleteData

protected PortletPreferences doDeleteData(PortletDataContext portletDataContext,
                                          String portletId,
                                          PortletPreferences portletPreferences)
                                   throws Exception

Overrides:

doDeleteData in class BasePortletDataHandler

Throws:

Exception

doExportData

protected String doExportData(PortletDataContext portletDataContext,
                              String portletId,
                              PortletPreferences portletPreferences)
                       throws Exception

Overrides:

doExportData in class BasePortletDataHandler

Throws:

Exception

doImportData

protected PortletPreferences doImportData(PortletDataContext portletDataContext,
                                          String portletId,
                                          PortletPreferences portletPreferences,
                                          String data)
                                   throws Exception

Overrides:

doImportData in class BasePortletDataHandler

Throws:

Exception