com.liferay.exportimport.kernel.lar

Interface ExportImportHelper

@ProviderType
public interface ExportImportHelper

Author:

Zsolt Berentey

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMP_FOLDER_NAME

Method Summary

Modifier and Type	Method and Description
long[]	getAllLayoutIds(long groupId, boolean privateLayout)
Map<Long,Boolean>	getAllLayoutIdsMap(long groupId, boolean privateLayout)
List<Portlet>	getDataSiteLevelPortlets(long companyId)
List<Portlet>	getDataSiteLevelPortlets(long companyId, boolean excludeDataAlwaysStaged)
String	getExportableRootPortletId(long companyId, String portletId)
Map<String,Boolean>	getExportPortletControlsMap(long companyId, String portletId, Map<String,String[]> parameterMap)
Map<String,Boolean>	getExportPortletControlsMap(long companyId, String portletId, Map<String,String[]> parameterMap, String type)
Map<String,Boolean>	getImportPortletControlsMap(long companyId, String portletId, Map<String,String[]> parameterMap, Element portletDataElement, ManifestSummary manifestSummary)
Map<Long,Boolean>	getLayoutIdMap(PortletRequest portletRequest)
long[]	getLayoutIds(List<Layout> layouts)
long[]	getLayoutIds(Map<Long,Boolean> layoutIdMap)
long[]	getLayoutIds(Map<Long,Boolean> layoutIdMap, long targetGroupId)
long[]	getLayoutIds(PortletRequest portletRequest)
long[]	getLayoutIds(PortletRequest portletRequest, long targetGroupId)
long	getLayoutModelDeletionCount(PortletDataContext portletDataContext, boolean privateLayout)
Layout	getLayoutOrCreateDummyRootLayout(long plid) Returns the layout with the primary key or a dummy root layout.
ZipWriter	getLayoutSetZipWriter(long groupId)
ManifestSummary	getManifestSummary(long userId, long groupId, Map<String,String[]> parameterMap, FileEntry fileEntry)
ManifestSummary	getManifestSummary(PortletDataContext portletDataContext)
List<Layout>	getMissingParentLayouts(Layout layout, long liveGroupId)
long	getModelDeletionCount(PortletDataContext portletDataContext, StagedModelType stagedModelType)
String	getPortletExportFileName(Portlet portlet)
ZipWriter	getPortletZipWriter(String portletId)
String	getSelectedLayoutsJSON(long groupId, boolean privateLayout, String selectedNodes)
FileEntry	getTempFileEntry(long groupId, long userId, String folderName)
UserIdStrategy	getUserIdStrategy(long userId, String userIdStrategy)
boolean	isAlwaysIncludeReference(PortletDataContext portletDataContext, StagedModel referenceStagedModel)
boolean	isAlwaysIncludeReference(PortletDataContext portletDataContext, StagedModel referenceStagedModel, String rootPortletId)
boolean	isExportPortletData(PortletDataContext portletDataContext)
boolean	isLayoutRevisionInReview(Layout layout)
boolean	isReferenceWithinExportScope(PortletDataContext portletDataContext, StagedModel stagedModel)
void	processBackgroundTaskManifestSummary(long userId, long sourceGroupId, BackgroundTask backgroundTask, File file)
void	setPortletScope(PortletDataContext portletDataContext, Element portletElement)
MissingReferences	validateMissingReferences(PortletDataContext portletDataContext)
void	writeManifestSummary(Document document, ManifestSummary manifestSummary)

Field Detail

TEMP_FOLDER_NAME

static final String TEMP_FOLDER_NAME

Method Detail

getAllLayoutIds

long[] getAllLayoutIds(long groupId,
                       boolean privateLayout)

getAllLayoutIdsMap

Map<Long,Boolean> getAllLayoutIdsMap(long groupId,
                                     boolean privateLayout)

getDataSiteLevelPortlets

List<Portlet> getDataSiteLevelPortlets(long companyId)
                                throws Exception

Throws:

Exception

getDataSiteLevelPortlets

List<Portlet> getDataSiteLevelPortlets(long companyId,
                                       boolean excludeDataAlwaysStaged)
                                throws Exception

Throws:

Exception

getExportableRootPortletId

String getExportableRootPortletId(long companyId,
                                  String portletId)
                           throws Exception

Throws:

Exception

getExportPortletControlsMap

Map<String,Boolean> getExportPortletControlsMap(long companyId,
                                                String portletId,
                                                Map<String,String[]> parameterMap)
                                         throws Exception

Throws:

Exception

getExportPortletControlsMap

Map<String,Boolean> getExportPortletControlsMap(long companyId,
                                                String portletId,
                                                Map<String,String[]> parameterMap,
                                                String type)
                                         throws Exception

Throws:

Exception

getImportPortletControlsMap

Map<String,Boolean> getImportPortletControlsMap(long companyId,
                                                String portletId,
                                                Map<String,String[]> parameterMap,
                                                Element portletDataElement,
                                                ManifestSummary manifestSummary)
                                         throws Exception

Throws:

Exception

getLayoutIdMap

Map<Long,Boolean> getLayoutIdMap(PortletRequest portletRequest)
                          throws PortalException

Throws:

PortalException

getLayoutIds

long[] getLayoutIds(List<Layout> layouts)

getLayoutIds

long[] getLayoutIds(Map<Long,Boolean> layoutIdMap)
             throws PortalException

Throws:

PortalException

getLayoutIds

long[] getLayoutIds(Map<Long,Boolean> layoutIdMap,
                    long targetGroupId)
             throws PortalException

Throws:

PortalException

getLayoutIds

long[] getLayoutIds(PortletRequest portletRequest)
             throws PortalException

Throws:

PortalException

getLayoutIds

long[] getLayoutIds(PortletRequest portletRequest,
                    long targetGroupId)
             throws PortalException

Throws:

PortalException

getLayoutModelDeletionCount

long getLayoutModelDeletionCount(PortletDataContext portletDataContext,
                                 boolean privateLayout)
                          throws PortalException

Throws:

PortalException

getLayoutOrCreateDummyRootLayout

Layout getLayoutOrCreateDummyRootLayout(long plid)
                                 throws PortalException

Returns the layout with the primary key or a dummy root layout.

Parameters:

plid - the primary key of the layout

Returns:

the layout

Throws:

PortalException - if the layout is not a dummy and no layout with the primary key could be found

getLayoutSetZipWriter

ZipWriter getLayoutSetZipWriter(long groupId)

getManifestSummary

ManifestSummary getManifestSummary(long userId,
                                   long groupId,
                                   Map<String,String[]> parameterMap,
                                   FileEntry fileEntry)
                            throws Exception

Throws:

Exception

getManifestSummary

ManifestSummary getManifestSummary(PortletDataContext portletDataContext)
                            throws Exception

Throws:

Exception

getMissingParentLayouts

List<Layout> getMissingParentLayouts(Layout layout,
                                     long liveGroupId)
                              throws PortalException

Throws:

PortalException

getModelDeletionCount

long getModelDeletionCount(PortletDataContext portletDataContext,
                           StagedModelType stagedModelType)
                    throws PortalException

Throws:

PortalException

getPortletExportFileName

String getPortletExportFileName(Portlet portlet)

getPortletZipWriter

ZipWriter getPortletZipWriter(String portletId)

getSelectedLayoutsJSON

String getSelectedLayoutsJSON(long groupId,
                              boolean privateLayout,
                              String selectedNodes)

getTempFileEntry

FileEntry getTempFileEntry(long groupId,
                           long userId,
                           String folderName)
                    throws PortalException

Throws:

PortalException

getUserIdStrategy

UserIdStrategy getUserIdStrategy(long userId,
                                 String userIdStrategy)
                          throws PortalException

Throws:

PortalException

isAlwaysIncludeReference

boolean isAlwaysIncludeReference(PortletDataContext portletDataContext,
                                 StagedModel referenceStagedModel)

isAlwaysIncludeReference

boolean isAlwaysIncludeReference(PortletDataContext portletDataContext,
                                 StagedModel referenceStagedModel,
                                 String rootPortletId)

isExportPortletData

boolean isExportPortletData(PortletDataContext portletDataContext)

isLayoutRevisionInReview

boolean isLayoutRevisionInReview(Layout layout)

isReferenceWithinExportScope

boolean isReferenceWithinExportScope(PortletDataContext portletDataContext,
                                     StagedModel stagedModel)

processBackgroundTaskManifestSummary

void processBackgroundTaskManifestSummary(long userId,
                                          long sourceGroupId,
                                          BackgroundTask backgroundTask,
                                          File file)
                                   throws PortalException

Throws:

PortalException

setPortletScope

void setPortletScope(PortletDataContext portletDataContext,
                     Element portletElement)

validateMissingReferences

MissingReferences validateMissingReferences(PortletDataContext portletDataContext)
                                     throws Exception

Throws:

Exception

writeManifestSummary

void writeManifestSummary(Document document,
                          ManifestSummary manifestSummary)