com.liferay.exportimport.kernel.configuration

Interface ExportImportConfigurationSettingsMapFactory

@ProviderType
public interface ExportImportConfigurationSettingsMapFactory

Provides a way to build a settings map for an ExportImportConfiguration, which can be used to start and control an export, import, or staging process.

Since:

7.0

Author:

Daniel Kocsis, Akos Thurzo

Method Summary

Modifier and Type	Method and Description
Map<String,Serializable>	buildExportLayoutSettingsMap(long userId, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Locale locale, TimeZone timeZone)
Map<String,Serializable>	buildExportLayoutSettingsMap(User user, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap)
Map<String,Serializable>	buildExportPortletSettingsMap(long userId, long sourcePlid, long sourceGroupId, String portletId, Map<String,String[]> parameterMap, Locale locale, TimeZone timeZone, String fileName)
Map<String,Serializable>	buildExportPortletSettingsMap(User user, long sourcePlid, long sourceGroupId, String portletId, Map<String,String[]> parameterMap, String fileName)
Map<String,Serializable>	buildImportLayoutSettingsMap(long userId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Locale locale, TimeZone timeZone)
Map<String,Serializable>	buildImportLayoutSettingsMap(User user, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap)
Map<String,Serializable>	buildImportPortletSettingsMap(long userId, long targetPlid, long targetGroupId, String portletId, Map<String,String[]> parameterMap, Locale locale, TimeZone timeZone)
Map<String,Serializable>	buildImportPortletSettingsMap(User user, long targetPlid, long targetGroupId, String portletId, Map<String,String[]> parameterMap)
Map<String,Serializable>	buildPublishLayoutLocalSettingsMap(long userId, long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Locale locale, TimeZone timeZone)
Map<String,Serializable>	buildPublishLayoutLocalSettingsMap(User user, long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap)
Map<String,Serializable>	buildPublishLayoutRemoteSettingsMap(long userId, long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Locale locale, TimeZone timeZone)
Map<String,Serializable>	buildPublishLayoutRemoteSettingsMap(User user, long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout)
Map<String,Serializable>	buildPublishPortletSettingsMap(long userId, long sourceGroupId, long sourcePlid, long targetGroupId, long targetPlid, String portletId, Map<String,String[]> parameterMap, Locale locale, TimeZone timeZone)
Map<String,Serializable>	buildPublishPortletSettingsMap(User user, long sourceGroupId, long sourcePlid, long targetGroupId, long targetPlid, String portletId, Map<String,String[]> parameterMap)
Map<String,Serializable>	buildSettingsMap(PortletRequest portletRequest, long groupId, int type) Returns an export layout settings map if the type is ExportImportConfigurationConstants.TYPE_EXPORT_LAYOUT; otherwise, returns either a local or remote publish layout settings map, depending on the staging type.

Method Detail

buildExportLayoutSettingsMap

Map<String,Serializable> buildExportLayoutSettingsMap(long userId,
                                                      long groupId,
                                                      boolean privateLayout,
                                                      long[] layoutIds,
                                                      Map<String,String[]> parameterMap,
                                                      Locale locale,
                                                      TimeZone timeZone)

buildExportLayoutSettingsMap

Map<String,Serializable> buildExportLayoutSettingsMap(User user,
                                                      long groupId,
                                                      boolean privateLayout,
                                                      long[] layoutIds,
                                                      Map<String,String[]> parameterMap)

buildExportPortletSettingsMap

Map<String,Serializable> buildExportPortletSettingsMap(long userId,
                                                       long sourcePlid,
                                                       long sourceGroupId,
                                                       String portletId,
                                                       Map<String,String[]> parameterMap,
                                                       Locale locale,
                                                       TimeZone timeZone,
                                                       String fileName)

buildExportPortletSettingsMap

Map<String,Serializable> buildExportPortletSettingsMap(User user,
                                                       long sourcePlid,
                                                       long sourceGroupId,
                                                       String portletId,
                                                       Map<String,String[]> parameterMap,
                                                       String fileName)

buildImportLayoutSettingsMap

Map<String,Serializable> buildImportLayoutSettingsMap(long userId,
                                                      long targetGroupId,
                                                      boolean privateLayout,
                                                      long[] layoutIds,
                                                      Map<String,String[]> parameterMap,
                                                      Locale locale,
                                                      TimeZone timeZone)

buildImportLayoutSettingsMap

Map<String,Serializable> buildImportLayoutSettingsMap(User user,
                                                      long targetGroupId,
                                                      boolean privateLayout,
                                                      long[] layoutIds,
                                                      Map<String,String[]> parameterMap)

buildImportPortletSettingsMap

Map<String,Serializable> buildImportPortletSettingsMap(long userId,
                                                       long targetPlid,
                                                       long targetGroupId,
                                                       String portletId,
                                                       Map<String,String[]> parameterMap,
                                                       Locale locale,
                                                       TimeZone timeZone)

buildImportPortletSettingsMap

Map<String,Serializable> buildImportPortletSettingsMap(User user,
                                                       long targetPlid,
                                                       long targetGroupId,
                                                       String portletId,
                                                       Map<String,String[]> parameterMap)

buildPublishLayoutLocalSettingsMap

Map<String,Serializable> buildPublishLayoutLocalSettingsMap(long userId,
                                                            long sourceGroupId,
                                                            long targetGroupId,
                                                            boolean privateLayout,
                                                            long[] layoutIds,
                                                            Map<String,String[]> parameterMap,
                                                            Locale locale,
                                                            TimeZone timeZone)

buildPublishLayoutLocalSettingsMap

Map<String,Serializable> buildPublishLayoutLocalSettingsMap(User user,
                                                            long sourceGroupId,
                                                            long targetGroupId,
                                                            boolean privateLayout,
                                                            long[] layoutIds,
                                                            Map<String,String[]> parameterMap)

buildPublishLayoutRemoteSettingsMap

Map<String,Serializable> buildPublishLayoutRemoteSettingsMap(long userId,
                                                             long sourceGroupId,
                                                             boolean privateLayout,
                                                             Map<Long,Boolean> layoutIdMap,
                                                             Map<String,String[]> parameterMap,
                                                             String remoteAddress,
                                                             int remotePort,
                                                             String remotePathContext,
                                                             boolean secureConnection,
                                                             long remoteGroupId,
                                                             boolean remotePrivateLayout,
                                                             Locale locale,
                                                             TimeZone timeZone)

buildPublishLayoutRemoteSettingsMap

Map<String,Serializable> buildPublishLayoutRemoteSettingsMap(User user,
                                                             long sourceGroupId,
                                                             boolean privateLayout,
                                                             Map<Long,Boolean> layoutIdMap,
                                                             Map<String,String[]> parameterMap,
                                                             String remoteAddress,
                                                             int remotePort,
                                                             String remotePathContext,
                                                             boolean secureConnection,
                                                             long remoteGroupId,
                                                             boolean remotePrivateLayout)

buildPublishPortletSettingsMap

Map<String,Serializable> buildPublishPortletSettingsMap(long userId,
                                                        long sourceGroupId,
                                                        long sourcePlid,
                                                        long targetGroupId,
                                                        long targetPlid,
                                                        String portletId,
                                                        Map<String,String[]> parameterMap,
                                                        Locale locale,
                                                        TimeZone timeZone)

buildPublishPortletSettingsMap

Map<String,Serializable> buildPublishPortletSettingsMap(User user,
                                                        long sourceGroupId,
                                                        long sourcePlid,
                                                        long targetGroupId,
                                                        long targetPlid,
                                                        String portletId,
                                                        Map<String,String[]> parameterMap)

buildSettingsMap

Map<String,Serializable> buildSettingsMap(PortletRequest portletRequest,
                                          long groupId,
                                          int type)
                                   throws PortalException

Returns an export layout settings map if the type is ExportImportConfigurationConstants.TYPE_EXPORT_LAYOUT; otherwise, returns either a local or remote publish layout settings map, depending on the staging type.

Parameters:

portletRequest - the portlet request

groupId - the primary key of the group

type - the export/import option type

Returns:

an export layout settings map if the type is an export layout; otherwise, returns either a local or remote publish layout settings map, depending on the staging type

Throws:

PortalException