com.liferay.layout.util

Interface BulkLayoutConverter

public interface BulkLayoutConverter

Method Summary

Modifier and Type	Method and Description
void	convertLayout(long plid) Converts a layout of type LayoutConstants#TYPE_PORTLET into a layout of type LayoutConstants#TYPE_CONTENT
long[]	convertLayouts(long groupId) Converts all convertible layouts in the group of type LayoutConstants#TYPE_PORTLET into layouts of type LayoutConstants#TYPE_CONTENT
long[]	convertLayouts(long[] plids) Converts multiple layouts of type LayoutConstants#TYPE_PORTLET into layouts of type LayoutConstants#TYPE_CONTENT
com.liferay.portal.kernel.model.Layout	generatePreviewLayout(long plid) Deprecated. As of Athanasius (7.3.x), replaced by generatePreviewLayout(long, Locale)
default LayoutConversionResult	generatePreviewLayout(long plid, java.util.Locale locale)
long[]	getConvertibleLayoutPlids(long groupId) Returns the plids of the convertible layouts in the group

Method Detail

convertLayout

void convertLayout(long plid)
            throws com.liferay.portal.kernel.exception.PortalException

Converts a layout of type LayoutConstants#TYPE_PORTLET into a layout of type LayoutConstants#TYPE_CONTENT

Parameters:

plid - the primary key of the layout

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

convertLayouts

long[] convertLayouts(long groupId)
               throws com.liferay.portal.kernel.exception.PortalException

Converts all convertible layouts in the group of type LayoutConstants#TYPE_PORTLET into layouts of type LayoutConstants#TYPE_CONTENT

This method handles the conversion of each layout within a transaction.

Parameters:

groupId - the primary key of the group

Returns:

an array with the plids of the layouts that have been successfully converted

Throws:

com.liferay.portal.kernel.exception.PortalException

convertLayouts

long[] convertLayouts(long[] plids)

Converts multiple layouts of type LayoutConstants#TYPE_PORTLET into layouts of type LayoutConstants#TYPE_CONTENT

This method handles the conversion of each layout within a transaction.

Parameters:

plids - an array with the primary keys of the layouts to be converted

Returns:

an array with the plids of the layouts that have been successfully converted

generatePreviewLayout

@Deprecated
com.liferay.portal.kernel.model.Layout generatePreviewLayout(long plid)
                                                                  throws java.lang.Exception

Deprecated. As of Athanasius (7.3.x), replaced by generatePreviewLayout(long, Locale)

Throws:

java.lang.Exception

generatePreviewLayout

default LayoutConversionResult generatePreviewLayout(long plid,
                                                     java.util.Locale locale)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getConvertibleLayoutPlids

long[] getConvertibleLayoutPlids(long groupId)
                          throws com.liferay.portal.kernel.exception.PortalException

Returns the plids of the convertible layouts in the group

Parameters:

groupId - the primary key of the group

Returns:

an array with the plids of the convertible layouts in the group

Throws:

com.liferay.portal.kernel.exception.PortalException