|
Liferay 6.2.0-ce-m1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.kernel.lar.BasePortletDataHandler
public abstract class BasePortletDataHandler
| Constructor Summary | |
|---|---|
BasePortletDataHandler()
|
|
| Method Summary | |
|---|---|
PortletPreferences |
deleteData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
Deletes the data created by the portlet. |
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 |
exportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
Returns a string of data to be placed in the <portlet-data> section of the LAR file. |
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. |
PortletPreferences |
importData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences,
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 |
isAlwaysStaged()
|
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BasePortletDataHandler()
| Method Detail |
|---|
public PortletPreferences deleteData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
throws PortletDataException
PortletDataHandlerpreferences if it contains reference to data that
does not exist anymore.
deleteData in interface PortletDataHandlerportletDataContext - the context of the data deletionportletId - the portlet ID of the portletportletPreferences - the portlet preferences of the portlet
Null if the portlet preferences were unmodified by
this data handler.
PortletDataException - if a portlet data exception occurred
public String exportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
throws PortletDataException
PortletDataHandlerdata
parameter of importData().
exportData in interface PortletDataHandlerportletDataContext - the context of the data exportportletId - the portlet ID of the portletportletPreferences - the portlet preferences of the portlet
Null should be returned if no portlet
data is to be written out.
PortletDataException - if a portlet data exception occurredpublic String[] getDataPortletPreferences()
PortletDataHandler
getDataPortletPreferences in interface PortletDataHandlerpublic PortletDataHandlerControl[] getExportControls()
PortletDataHandler
getExportControls in interface PortletDataHandlerpublic PortletDataHandlerControl[] getExportMetadataControls()
PortletDataHandler
getExportMetadataControls in interface PortletDataHandlerpublic PortletDataHandlerControl[] getImportControls()
PortletDataHandler
getImportControls in interface PortletDataHandlerpublic PortletDataHandlerControl[] getImportMetadataControls()
PortletDataHandler
getImportMetadataControls in interface PortletDataHandler
public PortletPreferences importData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences,
String data)
throws PortletDataException
PortletDataHandlerpreferences to be saved in the new portlet.
importData in interface PortletDataHandlerportletDataContext - the context of the data importportletId - the portlet ID of the portletportletPreferences - the portlet preferences of the portletdata - the string data that was returned by
exportData()
Null if the portlet preferences were unmodified by
this data handler.
PortletDataException - if a portlet data exception occurredpublic boolean isAlwaysExportable()
PortletDataHandlertrue to allow the user to export data for this
portlet even though it may not belong to any pages. See LPS-1624.
isAlwaysExportable in interface PortletDataHandlertrue to allow the user to export data for this
portlet even though it may not belong to any pagespublic boolean isAlwaysStaged()
isAlwaysStaged in interface PortletDataHandlerpublic boolean isDataLocalized()
isDataLocalized in interface PortletDataHandlerpublic boolean isPublishToLiveByDefault()
PortletDataHandlertrue
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.
isPublishToLiveByDefault in interface PortletDataHandlertrue to publish to live by default
protected PortletPreferences doDeleteData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
throws Exception
Exception
protected String doExportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences)
throws Exception
Exception
protected PortletPreferences doImportData(PortletDataContext portletDataContext,
String portletId,
PortletPreferences portletPreferences,
String data)
throws Exception
Exception
|
Liferay 6.2.0-ce-m1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||