com.liferay.portlet.bookmarks.lar
Class BookmarksPortletDataHandlerImpl

java.lang.Object
  com.liferay.portal.kernel.lar.BasePortletDataHandler
      com.liferay.portlet.bookmarks.lar.BookmarksPortletDataHandlerImpl

All Implemented Interfaces:

PortletDataHandler

public class BookmarksPortletDataHandlerImpl
extends BasePortletDataHandler

Constructor Summary

BookmarksPortletDataHandlerImpl()

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)
protected void	exportEntry(PortletDataContext portletDataContext, Element foldersElement, Element entriesElement, BookmarksEntry entry)
protected void	exportFolder(PortletDataContext portletDataContext, Element foldersElement, Element entriesElement, BookmarksFolder folder)
protected void	exportParentFolder(PortletDataContext portletDataContext, Element foldersElement, long folderId)
protected String	getEntryPath(PortletDataContext portletDataContext, BookmarksEntry entry)
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.
protected String	getFolderPath(PortletDataContext portletDataContext, BookmarksFolder folder)
PortletDataHandlerControl[]	getImportControls() Returns an array of the controls defined for this data handler.
protected String	getImportFolderPath(PortletDataContext portletDataContext, long folderId)
PortletDataHandlerControl[]	getImportMetadataControls() Returns an array of the metadata controls defined for this data handler.
protected void	importEntry(PortletDataContext portletDataContext, Element entryElement, BookmarksEntry entry)
protected void	importFolder(PortletDataContext portletDataContext, String folderPath, BookmarksFolder folder)
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 com.liferay.portal.kernel.lar.BasePortletDataHandler

deleteData, exportData, getDataPortletPreferences, importData, isAlwaysStaged, isDataLocalized

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarksPortletDataHandlerImpl

public BookmarksPortletDataHandlerImpl()

Method Detail

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

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

Overrides:

isAlwaysExportable in class BasePortletDataHandler

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

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

exportEntry

protected void exportEntry(PortletDataContext portletDataContext,
                           Element foldersElement,
                           Element entriesElement,
                           BookmarksEntry entry)
                    throws Exception

Throws:

Exception

exportFolder

protected void exportFolder(PortletDataContext portletDataContext,
                            Element foldersElement,
                            Element entriesElement,
                            BookmarksFolder folder)
                     throws Exception

Throws:

Exception

exportParentFolder

protected void exportParentFolder(PortletDataContext portletDataContext,
                                  Element foldersElement,
                                  long folderId)
                           throws Exception

Throws:

Exception

getEntryPath

protected String getEntryPath(PortletDataContext portletDataContext,
                              BookmarksEntry entry)

getFolderPath

protected String getFolderPath(PortletDataContext portletDataContext,
                               BookmarksFolder folder)

getImportFolderPath

protected String getImportFolderPath(PortletDataContext portletDataContext,
                                     long folderId)

importEntry

protected void importEntry(PortletDataContext portletDataContext,
                           Element entryElement,
                           BookmarksEntry entry)
                    throws Exception

Throws:

Exception

importFolder

protected void importFolder(PortletDataContext portletDataContext,
                            String folderPath,
                            BookmarksFolder folder)
                     throws Exception

Throws:

Exception