com.liferay.portal.lar
Class InvokerPortletDataHandler

java.lang.Object
  extended by com.liferay.portal.lar.InvokerPortletDataHandler
All Implemented Interfaces:
PortletDataHandler

public class InvokerPortletDataHandler
extends java.lang.Object
implements PortletDataHandler

View Source

Author:
Bruno Farache, Raymond Augé

Constructor Summary
InvokerPortletDataHandler(PortletDataHandler portletDataHandler, java.lang.ClassLoader classLoader)
           
 
Method Summary
 javax.portlet.PortletPreferences deleteData(PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences preferences)
          Deletes the data created by the portlet.
 java.lang.String exportData(PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences preferences)
          Returns a string of data to be placed in the <portlet-data> section of the LAR file.
 PortletDataHandlerControl[] getExportControls()
          Returns an array of the controls defined for this data handler.
 PortletDataHandlerControl[] getImportControls()
          Returns an array of the controls defined for this data handler.
 javax.portlet.PortletPreferences importData(PortletDataContext context, java.lang.String portletId, javax.portlet.PortletPreferences preferences, java.lang.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
 

Constructor Detail

InvokerPortletDataHandler

public InvokerPortletDataHandler(PortletDataHandler portletDataHandler,
                                 java.lang.ClassLoader classLoader)
Method Detail

deleteData

public javax.portlet.PortletPreferences deleteData(PortletDataContext context,
                                                   java.lang.String portletId,
                                                   javax.portlet.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 java.lang.String exportData(PortletDataContext context,
                                   java.lang.String portletId,
                                   javax.portlet.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

getExportControls

public PortletDataHandlerControl[] getExportControls()
                                              throws PortletDataException
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
Returns:
an array of PortletDataHandlerControls
Throws:
PortletDataException

getImportControls

public PortletDataHandlerControl[] getImportControls()
                                              throws PortletDataException
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
Returns:
An array of PortletDataHandlerControls
Throws:
PortletDataException

importData

public javax.portlet.PortletPreferences importData(PortletDataContext context,
                                                   java.lang.String portletId,
                                                   javax.portlet.PortletPreferences preferences,
                                                   java.lang.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

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