com.liferay.portal.kernel.lar
Class BasePortletDataHandler

java.lang.Object
  com.liferay.portal.kernel.lar.BasePortletDataHandler

All Implemented Interfaces:

PortletDataHandler

Direct Known Subclasses:

BasePortletDataHandler, BlogsPortletDataHandlerImpl, BookmarksPortletDataHandlerImpl, CalendarPortletDataHandlerImpl, DLDisplayPortletDataHandlerImpl, DLPortletDataHandlerImpl, IGPortletDataHandlerImpl, JournalContentPortletDataHandlerImpl, JournalPortletDataHandlerImpl, MBPortletDataHandlerImpl, PageCommentsPortletDataHandlerImpl, PageRatingsPortletDataHandlerImpl, PollsDisplayPortletDataHandlerImpl, PollsPortletDataHandlerImpl, WikiDisplayPortletDataHandlerImpl, WikiPortletDataHandlerImpl

public abstract class BasePortletDataHandler
extends Object
implements PortletDataHandler

Constructor Summary

BasePortletDataHandler()

Method Summary

PortletPreferences	deleteData(PortletDataContext context, String portletId, PortletPreferences preferences) Deletes the data created by the portlet.
protected PortletPreferences	doDeleteData(PortletDataContext context, String portletId, PortletPreferences preferences)
protected String	doExportData(PortletDataContext context, String portletId, PortletPreferences preferences)
protected PortletPreferences	doImportData(PortletDataContext context, String portletId, PortletPreferences preferences, String data)
String	exportData(PortletDataContext context, String portletId, PortletPreferences preferences) Returns a string of data to be placed in the <portlet-data> section of the LAR file.
PortletPreferences	importData(PortletDataContext context, String portletId, PortletPreferences preferences, String data) Handles any special processing of the data when the portlet is imported into a new layout.
boolean	isAlwaysExportable() Returns true to allow the user to export data for this portlet even though it may not belong to any pages.
boolean	isPublishToLiveByDefault() Returns whether the data exported by this handler should be included by default when publishing to live.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.kernel.lar.PortletDataHandler

getExportControls, getImportControls

Constructor Detail

BasePortletDataHandler

public BasePortletDataHandler()

Method Detail

deleteData

public PortletPreferences deleteData(PortletDataContext context,
                                     String portletId,
                                     PortletPreferences preferences)
                              throws PortletDataException

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

Parameters:

context - the context of the data deletion

portletId - the portlet id of the portlet

preferences - the portlet preferences of the portlet

Returns:

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

Throws:

PortletDataException

exportData

public String exportData(PortletDataContext context,
                         String portletId,
                         PortletPreferences preferences)
                  throws PortletDataException

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

Parameters:

context - the context of the data export

portletId - the portlet id of the portlet

preferences - 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.

Throws:

PortletDataException

isAlwaysExportable

public boolean isAlwaysExportable()

Description copied from interface: PortletDataHandler

Returns true to allow the user to export data for this portlet even though it may not belong to any pages. See LPS-1624.

Specified by:

isAlwaysExportable in interface PortletDataHandler

Returns:

true to allow the user to export data for this portlet even though it may not belong to any pages

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

Returns:

true to publish to live by default

importData

public PortletPreferences importData(PortletDataContext context,
                                     String portletId,
                                     PortletPreferences preferences,
                                     String data)
                              throws PortletDataException

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

Parameters:

context - the context of the data import

portletId - the portlet id of the portlet

preferences - the portlet preferences of the portlet

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

Returns:

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

Throws:

PortletDataException

doDeleteData

protected PortletPreferences doDeleteData(PortletDataContext context,
                                          String portletId,
                                          PortletPreferences preferences)
                                   throws Exception

Throws:

Exception

doExportData

protected String doExportData(PortletDataContext context,
                              String portletId,
                              PortletPreferences preferences)
                       throws Exception

Throws:

Exception

doImportData

protected PortletPreferences doImportData(PortletDataContext context,
                                          String portletId,
                                          PortletPreferences preferences,
                                          String data)
                                   throws Exception

Throws:

Exception