| com.liferay.portal.kernel.lar.PortletDataHandler
All known Subclasses: com.liferay.portlet.bookmarks.lar.BookmarksPortletDataHandlerImpl, com.liferay.portlet.pagecomments.lar.PageCommentsPortletDataHandlerImpl, com.liferay.portlet.journal.lar.JournalContentPortletDataHandlerImpl, com.liferay.portlet.imagegallery.lar.IGPortletDataHandlerImpl, com.liferay.portlet.messageboards.lar.MBPortletDataHandlerImpl, com.liferay.portlet.blogs.lar.BlogsPortletDataHandlerImpl, com.liferay.portlet.pageratings.lar.PageRatingsPortletDataHandlerImpl, com.liferay.portlet.wiki.lar.WikiPortletDataHandlerImpl, com.liferay.portlet.polls.lar.PollsPortletDataHandlerImpl, com.liferay.portlet.journal.lar.JournalPortletDataHandlerImpl, com.liferay.portlet.calendar.lar.CalendarPortletDataHandlerImpl, com.liferay.portlet.documentlibrary.lar.DLPortletDataHandlerImpl,
| PortletDataHandler | | public interface PortletDataHandler (Code) | | View Source
A PortletDataHandler is a special class capable of exporting and
importing portlet specific data to a Liferay Archive file (LAR) when a
community's layouts are exported or imported.
PortletDataHandlers are defined by placing a
portlet-data-handler-class element in the portlet
section of the liferay-portlet.xml file.
author:
Raymond Augé
author:
Joel Kozikowski
author:
Bruno Farache |
| deleteData | | public PortletPreferences deleteData(PortletDataContext context, String portletId, PortletPreferences prefs) throws PortletDataException(Code) | | Deletes the data created by the portlet. Can optionally return a modified
version of prefs if it contains reference to data that
does not exist anymore.
Parameters:
context - the context of the data deletion
Parameters:
portletId - the portlet id of the portlet
Parameters:
prefs - the portlet preferences of the portlet A modified version of prefs that should be saved. Null ifthe preferences were unmodified by this data handler.
throws:
PortletDataException - |
| exportData | | public String exportData(PortletDataContext context, String portletId, PortletPreferences prefs) throws PortletDataException(Code) | | 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().
Parameters:
context - the context of the data export
Parameters:
portletId - the portlet id of the portlet
Parameters:
prefs - the portlet preferences of the portlet A string of data to be placed in the LAR. It may be XML,but not necessarily. Null should be returned if no portletdata is to be written out.
throws:
PortletDataException - |
| getExportControls | | public PortletDataHandlerControl[] getExportControls() throws PortletDataException(Code) | | 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.
an array of PortletDataHandlerControls |
| getImportControls | | public PortletDataHandlerControl[] getImportControls() throws PortletDataException(Code) | | 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.
An array of PortletDataHandlerControls |
| importData | | public PortletPreferences importData(PortletDataContext context, String portletId, PortletPreferences prefs, String data) throws PortletDataException(Code) | | Handles any special processing of the data when the portlet is imported
into a new layout. Can optionally return a modified version of
prefs to be saved in the new portlet.
Parameters:
context - the context of the data import
Parameters:
portletId - the portlet id of the portlet
Parameters:
prefs - the portlet preferences of the portlet
Parameters:
data - the string data that was returned byexportData() A modified version of prefs that should besaved. Null if the preferences were unmodified by this datahandler.
throws:
PortletDataException - |
|
|