LayoutServiceWrapper (Liferay 7.0.10 portal-kernel API)

Object
- com.liferay.portal.kernel.service.LayoutServiceWrapper

All Implemented Interfaces:

BaseService, LayoutService, ServiceWrapper<LayoutService>
```
@ProviderType
public class LayoutServiceWrapper
extends Object
implements LayoutService, ServiceWrapper<LayoutService>
```
Provides a wrapper for LayoutService.

Author:

Brian Wing Shun Chan

See Also:

LayoutService

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

LayoutServiceWrapper(LayoutService layoutService)

Constructors
Constructor and Description
`LayoutServiceWrapper(LayoutService layoutService)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Layout`	`addLayout(long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)` Adds a layout with additional parameters.
`Layout`	`addLayout(long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext)` Adds a layout with single entry maps for name, title, and description to the default locale.
`FileEntry`	`addTempFileEntry(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType)`
`void`	`deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext)` Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
`void`	`deleteLayout(long plid, ServiceContext serviceContext)` Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
`void`	`deleteTempFileEntry(long groupId, String folderName, String fileName)`
`byte[]`	`exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`byte[]`	`exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`File`	`exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.exportLayoutsAsFile( ExportImportConfiguration)`
`File`	`exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`exportLayoutsAsFileInBackground(ExportImportConfiguration exportImportConfiguration)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.exportLayoutsAsFileInBackground( ExportImportConfiguration)`
`long`	`exportLayoutsAsFileInBackground(long exportImportConfigurationId)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.exportLayoutsAsFileInBackground( long)`
`long`	`exportLayoutsAsFileInBackground(String taskName, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`exportLayoutsAsFileInBackground(String taskName, long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`byte[]`	`exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`byte[]`	`exportPortletInfo(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`File`	`exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.exportPortletInfoAsFile( ExportImportConfiguration)`
`File`	`exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`File`	`exportPortletInfoAsFile(String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`exportPortletInfoAsFileInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`exportPortletInfoAsFileInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate, String fileName)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`List<Layout>`	`getAncestorLayouts(long plid)` Returns all the ancestor layouts of the layout.
`long`	`getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, String portletId)` Returns the primary key of the default layout for the group.
`long`	`getDefaultPlid(long groupId, long scopeGroupId, String portletId)`
`Layout`	`getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)` Returns the layout matching the UUID, group, and privacy.
`String`	`getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId)` Returns the name of the layout.
`LayoutReference[]`	`getLayoutReferences(long companyId, String portletId, String preferencesKey, String preferencesValue)` Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout)`
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId)`
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)`
`int`	`getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)`
`int`	`getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId, int priority)`
`String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`String[]`	`getTempFileNames(long groupId, String folderName)`
`LayoutService`	`getWrappedService()`
`void`	`importLayouts(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.importLayouts( ExportImportConfiguration, File)`
`void`	`importLayouts(ExportImportConfiguration exportImportConfiguration, InputStream is)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.importLayouts( ExportImportConfiguration, InputStream)`
`void`	`importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`importLayoutsInBackground(String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`importLayoutsInBackground(String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfo(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.importPortletInfo( ExportImportConfiguration, File)` (
`void`	`importPortletInfo(ExportImportConfiguration exportImportConfiguration, InputStream is)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.importPortletInfo( ExportImportConfiguration, InputStream)` (
`void`	`importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfo(String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfo(String portletId, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`importPortletInfoInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`importPortletInfoInBackground(String taskName, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfoInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfoInBackground(String taskName, String portletId, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)` Deprecated. As of Wilberforce (7.0.x), replaced by `schedulePublishToLive(long, long, boolean, long[], Map, String, String, Date, Date, String)`
`void`	`schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)` Schedules a range of layouts to be published.
`void`	`schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)` Deprecated. As of Wilberforce (7.0.x), replaced by `schedulePublishToLive(long, long, boolean, long[], Map, String, Date, Date, String, String, Date, Date, String)`
`void`	`schedulePublishToRemote(long sourceGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description)` Schedules a range of layouts to be stored.
`void`	`setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext)` Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
`void`	`setWrappedService(LayoutService layoutService)`
`void`	`unschedulePublishToLive(long groupId, String jobName, String groupName)` Deletes the job from the scheduler's queue.
`void`	`unschedulePublishToRemote(long groupId, String jobName, String groupName)` Deletes the job from the scheduler's persistent queue.
`Layout`	`updateIconImage(long plid, byte[] bytes)`
`Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> localeNamesMap, Map<Locale,String> localeTitlesMap, Map<Locale,String> descriptionMap, Map<Locale,String> keywordsMap, Map<Locale,String> robotsMap, String type, boolean hidden, Map<Locale,String> friendlyURLMap, boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)` Updates the layout with additional parameters.
`Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings)` Updates the layout replacing its type settings.
`Layout`	`updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css)` Updates the look and feel of the layout.
`Layout`	`updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId)` Updates the name of the layout matching the group, layout ID, and privacy.
`Layout`	`updateName(long plid, String name, String languageId)` Updates the name of the layout matching the primary key.
`Layout`	`updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)` Updates the parent layout ID of the layout matching the group, layout ID, and privacy.
`Layout`	`updateParentLayoutId(long plid, long parentPlid)` Updates the parent layout ID of the layout matching the primary key.
`Layout`	`updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority)` Updates the parent layout ID and priority of the layout.
`Layout`	`updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)` Updates the priority of the layout matching the group, layout ID, and privacy.
`Layout`	`updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId)` Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.
`Layout`	`updatePriority(long plid, int priority)` Updates the priority of the layout matching the primary key.
`MissingReferences`	`validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportLayoutsFile( ExportImportConfiguration, File)`
`MissingReferences`	`validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportLayoutsFile( ExportImportConfiguration, InputStream)`
`MissingReferences`	`validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`MissingReferences`	`validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`MissingReferences`	`validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportPortletInfo( ExportImportConfiguration, File)`
`MissingReferences`	`validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportPortletInfo( ExportImportConfiguration, InputStream)`
`MissingReferences`	`validateImportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`MissingReferences`	`validateImportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LayoutServiceWrapper
```
public LayoutServiceWrapper(LayoutService layoutService)
```
- Method Detail
  - addLayout
```
public Layout addLayout(long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        Map<Locale,String> localeNamesMap,
                        Map<Locale,String> localeTitlesMap,
                        Map<Locale,String> descriptionMap,
                        Map<Locale,String> keywordsMap,
                        Map<Locale,String> robotsMap,
                        String type,
                        String typeSettings,
                        boolean hidden,
                        Map<Locale,String> friendlyURLMap,
                        ServiceContext serviceContext)
                 throws PortalException
```
    Adds a layout with additional parameters.
    This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
    
    Specified by:
    
    addLayout in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parentLayoutId - the primary key of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
    
    localeNamesMap - the layout's locales and localized names
    
    localeTitlesMap - the layout's locales and localized titles
    
    descriptionMap - the layout's locales and localized descriptions
    
    keywordsMap - the layout's locales and localized keywords
    
    robotsMap - the layout's locales and localized robots
    
    type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.
    
    typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
    
    hidden - whether the layout is hidden
    
    friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).
    
    serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
    
    Returns:
    
    the layout
    
    Throws:
    
    PortalException
  - addLayout
```
public Layout addLayout(long groupId,
                        boolean privateLayout,
                        long parentLayoutId,
                        String name,
                        String title,
                        String description,
                        String type,
                        boolean hidden,
                        String friendlyURL,
                        ServiceContext serviceContext)
                 throws PortalException
```
    Adds a layout with single entry maps for name, title, and description to the default locale.
    This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
    
    Specified by:
    
    addLayout in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parentLayoutId - the primary key of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
    
    name - the layout's locales and localized names
    
    title - the layout's locales and localized titles
    
    description - the layout's locales and localized descriptions
    
    type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.
    
    hidden - whether the layout is hidden
    
    friendlyURL - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).
    
    serviceContext - the service context to be applied. Must set the UUID for the layout. Can specify the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.
    
    Returns:
    
    the layout
    
    Throws:
    
    PortalException
  - addTempFileEntry
```
public FileEntry addTempFileEntry(long groupId,
                                  String folderName,
                                  String fileName,
                                  InputStream inputStream,
                                  String mimeType)
                           throws PortalException
```
    Specified by:
    
    addTempFileEntry in interface LayoutService
    
    Throws:
    
    PortalException
  - deleteLayout
```
public void deleteLayout(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         ServiceContext serviceContext)
                  throws PortalException
```
    Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
    
    Specified by:
    
    deleteLayout in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    serviceContext - the service context to be applied
    
    Throws:
    
    PortalException
  - deleteLayout
```
public void deleteLayout(long plid,
                         ServiceContext serviceContext)
                  throws PortalException
```
    Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
    
    Specified by:
    
    deleteLayout in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    serviceContext - the service context to be applied
    
    Throws:
    
    PortalException
  - deleteTempFileEntry
```
public void deleteTempFileEntry(long groupId,
                                String folderName,
                                String fileName)
                         throws PortalException
```
    Specified by:
    
    deleteTempFileEntry in interface LayoutService
    
    Throws:
    
    PortalException
  - exportLayouts
```
@Deprecated
public byte[] exportLayouts(long groupId,
                                        boolean privateLayout,
                                        long[] layoutIds,
                                        Map<String,String[]> parameterMap,
                                        Date startDate,
                                        Date endDate)
                                 throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Exports the layouts that match the primary keys and the criteria as a byte array.
    
    Specified by:
    
    exportLayouts in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutIds - the primary keys of the layouts to be exported
    
    parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
    
    startDate - the export's start date
    
    endDate - the export's end date
    
    Returns:
    
    the layouts as a byte array
    
    Throws:
    
    PortalException
  - exportLayouts
```
@Deprecated
public byte[] exportLayouts(long groupId,
                                        boolean privateLayout,
                                        Map<String,String[]> parameterMap,
                                        Date startDate,
                                        Date endDate)
                                 throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Exports all layouts that match the criteria as a byte array.
    
    Specified by:
    
    exportLayouts in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
    
    startDate - the export's start date
    
    endDate - the export's end date
    
    Returns:
    
    the layout as a byte array
    
    Throws:
    
    PortalException
  - exportLayoutsAsFile
```
@Deprecated
public File exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)
                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFile( ExportImportConfiguration)
    
    Specified by:
    
    exportLayoutsAsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - exportLayoutsAsFile
```
@Deprecated
public File exportLayoutsAsFile(long groupId,
                                            boolean privateLayout,
                                            long[] layoutIds,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate)
                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Exports all layouts that match the primary keys and criteria as a file.
    
    Specified by:
    
    exportLayoutsAsFile in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutIds - the primary keys of the layouts to be exported (optionally null)
    
    parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
    
    startDate - the export's start date
    
    endDate - the export's end date
    
    Returns:
    
    the layouts as a File
    
    Throws:
    
    PortalException
  - exportLayoutsAsFileInBackground
```
@Deprecated
public long exportLayoutsAsFileInBackground(ExportImportConfiguration exportImportConfiguration)
                                                 throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( ExportImportConfiguration)
    
    Specified by:
    
    exportLayoutsAsFileInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - exportLayoutsAsFileInBackground
```
@Deprecated
public long exportLayoutsAsFileInBackground(long exportImportConfigurationId)
                                                 throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( long)
    
    Specified by:
    
    exportLayoutsAsFileInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - exportLayoutsAsFileInBackground
```
@Deprecated
public long exportLayoutsAsFileInBackground(String taskName,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        long[] layoutIds,
                                                        Map<String,String[]> parameterMap,
                                                        Date startDate,
                                                        Date endDate)
                                                 throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    exportLayoutsAsFileInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - exportLayoutsAsFileInBackground
```
@Deprecated
public long exportLayoutsAsFileInBackground(String taskName,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        long[] layoutIds,
                                                        Map<String,String[]> parameterMap,
                                                        Date startDate,
                                                        Date endDate,
                                                        String fileName)
                                                 throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    exportLayoutsAsFileInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - exportPortletInfo
```
@Deprecated
public byte[] exportPortletInfo(long plid,
                                            long groupId,
                                            String portletId,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate)
                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Exports the portlet information (categories, permissions, ... etc.) as a byte array.
    
    Specified by:
    
    exportPortletInfo in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    groupId - the primary key of the group
    
    portletId - the primary key of the portlet
    
    parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
    
    startDate - the export's start date
    
    endDate - the export's end date
    
    Returns:
    
    the portlet information as a byte array
    
    Throws:
    
    PortalException
  - exportPortletInfo
```
@Deprecated
public byte[] exportPortletInfo(long companyId,
                                            String portletId,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate)
                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    exportPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - exportPortletInfoAsFile
```
@Deprecated
public File exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)
                                         throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportPortletInfoAsFile( ExportImportConfiguration)
    
    Specified by:
    
    exportPortletInfoAsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - exportPortletInfoAsFile
```
@Deprecated
public File exportPortletInfoAsFile(long plid,
                                                long groupId,
                                                String portletId,
                                                Map<String,String[]> parameterMap,
                                                Date startDate,
                                                Date endDate)
                                         throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Exports the portlet information (categories, permissions, ... etc.) as a file.
    
    Specified by:
    
    exportPortletInfoAsFile in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    groupId - the primary key of the group
    
    portletId - the primary key of the portlet
    
    parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.
    
    startDate - the export's start date
    
    endDate - the export's end date
    
    Returns:
    
    the portlet information as a file
    
    Throws:
    
    PortalException
  - exportPortletInfoAsFile
```
@Deprecated
public File exportPortletInfoAsFile(String portletId,
                                                Map<String,String[]> parameterMap,
                                                Date startDate,
                                                Date endDate)
                                         throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    exportPortletInfoAsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - exportPortletInfoAsFileInBackground
```
@Deprecated
public long exportPortletInfoAsFileInBackground(String taskName,
                                                            long plid,
                                                            long groupId,
                                                            String portletId,
                                                            Map<String,String[]> parameterMap,
                                                            Date startDate,
                                                            Date endDate,
                                                            String fileName)
                                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    exportPortletInfoAsFileInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - exportPortletInfoAsFileInBackground
```
@Deprecated
public long exportPortletInfoAsFileInBackground(String taskName,
                                                            String portletId,
                                                            Map<String,String[]> parameterMap,
                                                            Date startDate,
                                                            Date endDate,
                                                            String fileName)
                                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    exportPortletInfoAsFileInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - getAncestorLayouts
```
public List<Layout> getAncestorLayouts(long plid)
                                throws PortalException
```
    Returns all the ancestor layouts of the layout.
    
    Specified by:
    
    getAncestorLayouts in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    Returns:
    
    the ancestor layouts of the layout
    
    Throws:
    
    PortalException
  - getDefaultPlid
```
public long getDefaultPlid(long groupId,
                           long scopeGroupId,
                           boolean privateLayout,
                           String portletId)
                    throws PortalException
```
    Returns the primary key of the default layout for the group.
    
    Specified by:
    
    getDefaultPlid in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    scopeGroupId - the primary key of the scope group. See ServiceContext.getScopeGroupId().
    
    privateLayout - whether the layout is private to the group
    
    portletId - the primary key of the portlet
    
    Returns:
    
    Returns the primary key of the default layout group; LayoutConstants#DEFAULT_PLID otherwise
    
    Throws:
    
    PortalException
  - getDefaultPlid
```
public long getDefaultPlid(long groupId,
                           long scopeGroupId,
                           String portletId)
                    throws PortalException
```
    Specified by:
    
    getDefaultPlid in interface LayoutService
    
    Throws:
    
    PortalException
  - getLayoutByUuidAndGroupId
```
public Layout getLayoutByUuidAndGroupId(String uuid,
                                        long groupId,
                                        boolean privateLayout)
                                 throws PortalException
```
    Returns the layout matching the UUID, group, and privacy.
    
    Specified by:
    
    getLayoutByUuidAndGroupId in interface LayoutService
    
    Parameters:
    
    uuid - the layout's UUID
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    Returns:
    
    the matching layout
    
    Throws:
    
    PortalException
  - getLayoutName
```
public String getLayoutName(long groupId,
                            boolean privateLayout,
                            long layoutId,
                            String languageId)
                     throws PortalException
```
    Returns the name of the layout.
    
    Specified by:
    
    getLayoutName in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    languageId - the primary key of the language. For more information See Locale.
    
    Returns:
    
    the layout's name
    
    Throws:
    
    PortalException
  - getLayoutReferences
```
public LayoutReference[] getLayoutReferences(long companyId,
                                             String portletId,
                                             String preferencesKey,
                                             String preferencesValue)
```
    Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.
    
    Specified by:
    
    getLayoutReferences in interface LayoutService
    
    Parameters:
    
    companyId - the primary key of the company
    
    portletId - the primary key of the portlet
    
    preferencesKey - the portlet's preference key
    
    preferencesValue - the portlet's preference value
    
    Returns:
    
    the layout references of the matching layouts
  - getLayouts
```
public List<Layout> getLayouts(long groupId,
                               boolean privateLayout)
```
    Specified by:
    
    getLayouts in interface LayoutService
  - getLayouts
```
public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long parentLayoutId)
                        throws PortalException
```
    Specified by:
    
    getLayouts in interface LayoutService
    
    Throws:
    
    PortalException
  - getLayouts
```
public List<Layout> getLayouts(long groupId,
                               boolean privateLayout,
                               long parentLayoutId,
                               boolean incomplete,
                               int start,
                               int end)
                        throws PortalException
```
    Specified by:
    
    getLayouts in interface LayoutService
    
    Throws:
    
    PortalException
  - getLayoutsCount
```
public int getLayoutsCount(long groupId,
                           boolean privateLayout,
                           long parentLayoutId)
```
    Specified by:
    
    getLayoutsCount in interface LayoutService
  - getLayoutsCount
```
public int getLayoutsCount(long groupId,
                           boolean privateLayout,
                           long parentLayoutId,
                           int priority)
```
    Specified by:
    
    getLayoutsCount in interface LayoutService
  - getOSGiServiceIdentifier
```
public String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Specified by:
    
    getOSGiServiceIdentifier in interface LayoutService
    
    Returns:
    
    the OSGi service identifier
  - getTempFileNames
```
public String[] getTempFileNames(long groupId,
                                 String folderName)
                          throws PortalException
```
    Specified by:
    
    getTempFileNames in interface LayoutService
    
    Throws:
    
    PortalException
  - importLayouts
```
@Deprecated
public void importLayouts(ExportImportConfiguration exportImportConfiguration,
                                      File file)
                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.importLayouts( ExportImportConfiguration, File)
    
    Specified by:
    
    importLayouts in interface LayoutService
    
    Throws:
    
    PortalException
  - importLayouts
```
@Deprecated
public void importLayouts(ExportImportConfiguration exportImportConfiguration,
                                      InputStream is)
                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.importLayouts( ExportImportConfiguration, InputStream)
    
    Specified by:
    
    importLayouts in interface LayoutService
    
    Throws:
    
    PortalException
  - importLayouts
```
@Deprecated
public void importLayouts(long groupId,
                                      boolean privateLayout,
                                      Map<String,String[]> parameterMap,
                                      byte[] bytes)
                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Imports the layouts from the byte array.
    
    Specified by:
    
    importLayouts in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
    
    bytes - the byte array with the data
    
    Throws:
    
    PortalException
    
    See Also:
    
    com.liferay.exportimport.kernel.lar.LayoutImporter
  - importLayouts
```
@Deprecated
public void importLayouts(long groupId,
                                      boolean privateLayout,
                                      Map<String,String[]> parameterMap,
                                      File file)
                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Imports the layouts from the file.
    
    Specified by:
    
    importLayouts in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
    
    file - the LAR file with the data
    
    Throws:
    
    PortalException
    
    See Also:
    
    com.liferay.exportimport.kernel.lar.LayoutImporter
  - importLayouts
```
@Deprecated
public void importLayouts(long groupId,
                                      boolean privateLayout,
                                      Map<String,String[]> parameterMap,
                                      InputStream is)
                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Imports the layouts from the input stream.
    
    Specified by:
    
    importLayouts in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
    
    is - the input stream
    
    Throws:
    
    PortalException
    
    See Also:
    
    com.liferay.exportimport.kernel.lar.LayoutImporter
  - importLayoutsInBackground
```
@Deprecated
public long importLayoutsInBackground(String taskName,
                                                  long groupId,
                                                  boolean privateLayout,
                                                  Map<String,String[]> parameterMap,
                                                  File file)
                                           throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importLayoutsInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - importLayoutsInBackground
```
@Deprecated
public long importLayoutsInBackground(String taskName,
                                                  long groupId,
                                                  boolean privateLayout,
                                                  Map<String,String[]> parameterMap,
                                                  InputStream inputStream)
                                           throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importLayoutsInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfo
```
@Deprecated
public void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                          File file)
                                   throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.importPortletInfo( ExportImportConfiguration, File) (
    
    Specified by:
    
    importPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfo
```
@Deprecated
public void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                          InputStream is)
                                   throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.importPortletInfo( ExportImportConfiguration, InputStream) (
    
    Specified by:
    
    importPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfo
```
@Deprecated
public void importPortletInfo(long plid,
                                          long groupId,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          File file)
                                   throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Imports the portlet information (categories, permissions, ... etc.) from the file.
    
    Specified by:
    
    importPortletInfo in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    groupId - the primary key of the group
    
    portletId - the primary key of the portlet
    
    parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
    
    file - the LAR file with the data
    
    Throws:
    
    PortalException
  - importPortletInfo
```
@Deprecated
public void importPortletInfo(long plid,
                                          long groupId,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          InputStream is)
                                   throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Imports the portlet information (categories, permissions, ... etc.) from the input stream.
    
    Specified by:
    
    importPortletInfo in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    groupId - the primary key of the group
    
    portletId - the primary key of the portlet
    
    parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.
    
    is - the input stream
    
    Throws:
    
    PortalException
  - importPortletInfo
```
@Deprecated
public void importPortletInfo(String portletId,
                                          Map<String,String[]> parameterMap,
                                          File file)
                                   throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfo
```
@Deprecated
public void importPortletInfo(String portletId,
                                          Map<String,String[]> parameterMap,
                                          InputStream is)
                                   throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfoInBackground
```
@Deprecated
public long importPortletInfoInBackground(String taskName,
                                                      long plid,
                                                      long groupId,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      File file)
                                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importPortletInfoInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfoInBackground
```
@Deprecated
public long importPortletInfoInBackground(String taskName,
                                                      long plid,
                                                      long groupId,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      InputStream is)
                                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importPortletInfoInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfoInBackground
```
@Deprecated
public void importPortletInfoInBackground(String taskName,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      File file)
                                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importPortletInfoInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - importPortletInfoInBackground
```
@Deprecated
public void importPortletInfoInBackground(String taskName,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      InputStream is)
                                               throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    importPortletInfoInBackground in interface LayoutService
    
    Throws:
    
    PortalException
  - schedulePublishToLive
```
@Deprecated
public void schedulePublishToLive(long sourceGroupId,
                                              long targetGroupId,
                                              boolean privateLayout,
                                              long[] layoutIds,
                                              Map<String,String[]> parameterMap,
                                              String scope,
                                              Date startDate,
                                              Date endDate,
                                              String groupName,
                                              String cronText,
                                              Date schedulerStartDate,
                                              Date schedulerEndDate,
                                              String description)
                                       throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by schedulePublishToLive(long, long, boolean, long[], Map, String, String, Date, Date, String)
    
    Schedules a range of layouts to be published.
    
    Specified by:
    
    schedulePublishToLive in interface LayoutService
    
    Parameters:
    
    sourceGroupId - the primary key of the source group
    
    targetGroupId - the primary key of the target group
    
    privateLayout - whether the layout is private to the group
    
    layoutIds - the layouts considered for publishing, specified by the layout IDs
    
    parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.
    
    scope - the scope of the pages. It can be all-pages or selected-pages.
    
    startDate - the start date
    
    endDate - the end date
    
    groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
    
    cronText - the cron text. See #toCronText
    
    schedulerStartDate - the scheduler start date
    
    schedulerEndDate - the scheduler end date
    
    description - the scheduler description
    
    Throws:
    
    PortalException
  - schedulePublishToLive
```
public void schedulePublishToLive(long sourceGroupId,
                                  long targetGroupId,
                                  boolean privateLayout,
                                  long[] layoutIds,
                                  Map<String,String[]> parameterMap,
                                  String groupName,
                                  String cronText,
                                  Date schedulerStartDate,
                                  Date schedulerEndDate,
                                  String description)
                           throws PortalException
```
    Schedules a range of layouts to be published.
    
    Specified by:
    
    schedulePublishToLive in interface LayoutService
    
    Parameters:
    
    sourceGroupId - the primary key of the source group
    
    targetGroupId - the primary key of the target group
    
    privateLayout - whether the layout is private to the group
    
    layoutIds - the layouts considered for publishing, specified by the layout IDs
    
    parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.
    
    groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
    
    cronText - the cron text. See #toCronText
    
    schedulerStartDate - the scheduler start date
    
    schedulerEndDate - the scheduler end date
    
    description - the scheduler description
    
    Throws:
    
    PortalException
  - schedulePublishToLive
```
@Deprecated
public void schedulePublishToLive(long sourceGroupId,
                                              long targetGroupId,
                                              boolean privateLayout,
                                              Map<Long,Boolean> layoutIdMap,
                                              Map<String,String[]> parameterMap,
                                              String scope,
                                              Date startDate,
                                              Date endDate,
                                              String groupName,
                                              String cronText,
                                              Date schedulerStartDate,
                                              Date schedulerEndDate,
                                              String description)
                                       throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by schedulePublishToLive(long, long, boolean, long[], Map, String, Date, Date, String, String, Date, Date, String)
    
    Schedules a range of layouts to be published.
    
    Specified by:
    
    schedulePublishToLive in interface LayoutService
    
    Parameters:
    
    sourceGroupId - the primary key of the source group
    
    targetGroupId - the primary key of the target group
    
    privateLayout - whether the layout is private to the group
    
    layoutIdMap - the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have children
    
    parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.
    
    groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
    
    cronText - the cron text. See #toCronText
    
    schedulerStartDate - the scheduler start date
    
    schedulerEndDate - the scheduler end date
    
    description - the scheduler description
    
    Throws:
    
    PortalException
  - schedulePublishToRemote
```
public void schedulePublishToRemote(long sourceGroupId,
                                    boolean privateLayout,
                                    Map<Long,Boolean> layoutIdMap,
                                    Map<String,String[]> parameterMap,
                                    String remoteAddress,
                                    int remotePort,
                                    String remotePathContext,
                                    boolean secureConnection,
                                    long remoteGroupId,
                                    boolean remotePrivateLayout,
                                    Date startDate,
                                    Date endDate,
                                    String groupName,
                                    String cronText,
                                    Date schedulerStartDate,
                                    Date schedulerEndDate,
                                    String description)
                             throws PortalException
```
    Schedules a range of layouts to be stored.
    
    Specified by:
    
    schedulePublishToRemote in interface LayoutService
    
    Parameters:
    
    sourceGroupId - the primary key of the source group
    
    privateLayout - whether the layout is private to the group
    
    layoutIdMap - the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have children
    
    parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.
    
    remoteAddress - the remote address
    
    remotePort - the remote port
    
    remotePathContext - the remote path context
    
    secureConnection - whether the connection is secure
    
    remoteGroupId - the primary key of the remote group
    
    remotePrivateLayout - whether remote group's layout is private
    
    startDate - the start date
    
    endDate - the end date
    
    groupName - the group name. Optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
    
    cronText - the cron text. See #toCronText
    
    schedulerStartDate - the scheduler start date
    
    schedulerEndDate - the scheduler end date
    
    description - the scheduler description
    
    Throws:
    
    PortalException
  - setLayouts
```
public void setLayouts(long groupId,
                       boolean privateLayout,
                       long parentLayoutId,
                       long[] layoutIds,
                       ServiceContext serviceContext)
                throws PortalException
```
    Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
    
    Specified by:
    
    setLayouts in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    parentLayoutId - the primary key of the parent layout
    
    layoutIds - the primary keys of the layouts
    
    serviceContext - the service context to be applied
    
    Throws:
    
    PortalException
  - unschedulePublishToLive
```
public void unschedulePublishToLive(long groupId,
                                    String jobName,
                                    String groupName)
                             throws PortalException
```
    Deletes the job from the scheduler's queue.
    
    Specified by:
    
    unschedulePublishToLive in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    jobName - the job name
    
    groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
    
    Throws:
    
    PortalException
  - unschedulePublishToRemote
```
public void unschedulePublishToRemote(long groupId,
                                      String jobName,
                                      String groupName)
                               throws PortalException
```
    Deletes the job from the scheduler's persistent queue.
    
    Specified by:
    
    unschedulePublishToRemote in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    jobName - the job name
    
    groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.
    
    Throws:
    
    PortalException
  - updateIconImage
```
public Layout updateIconImage(long plid,
                              byte[] bytes)
                       throws PortalException
```
    Specified by:
    
    updateIconImage in interface LayoutService
    
    Throws:
    
    PortalException
  - updateLayout
```
public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           long parentLayoutId,
                           Map<Locale,String> localeNamesMap,
                           Map<Locale,String> localeTitlesMap,
                           Map<Locale,String> descriptionMap,
                           Map<Locale,String> keywordsMap,
                           Map<Locale,String> robotsMap,
                           String type,
                           boolean hidden,
                           Map<Locale,String> friendlyURLMap,
                           boolean iconImage,
                           byte[] iconBytes,
                           ServiceContext serviceContext)
                    throws PortalException
```
    Updates the layout with additional parameters.
    
    Specified by:
    
    updateLayout in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    parentLayoutId - the primary key of the layout's new parent layout
    
    localeNamesMap - the layout's locales and localized names
    
    localeTitlesMap - the layout's locales and localized titles
    
    descriptionMap - the locales and localized descriptions to merge (optionally null)
    
    keywordsMap - the locales and localized keywords to merge (optionally null)
    
    robotsMap - the locales and localized robots to merge (optionally null)
    
    type - the layout's new type (optionally LayoutConstants#TYPE_PORTLET)
    
    hidden - whether the layout is hidden
    
    friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).
    
    iconImage - whether the icon image will be updated
    
    iconBytes - the byte array of the layout's new icon image
    
    serviceContext - the service context to be applied. Can set the modification date and expando bridge attributes for the layout.
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updateLayout
```
public Layout updateLayout(long groupId,
                           boolean privateLayout,
                           long layoutId,
                           String typeSettings)
                    throws PortalException
```
    Updates the layout replacing its type settings.
    
    Specified by:
    
    updateLayout in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    typeSettings - the settings to load the unicode properties object. See #fastLoad(String).
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updateLookAndFeel
```
public Layout updateLookAndFeel(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                String themeId,
                                String colorSchemeId,
                                String css)
                         throws PortalException
```
    Updates the look and feel of the layout.
    
    Specified by:
    
    updateLookAndFeel in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    themeId - the primary key of the layout's new theme
    
    colorSchemeId - the primary key of the layout's new color scheme
    
    css - the layout's new CSS
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updateName
```
public Layout updateName(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         String name,
                         String languageId)
                  throws PortalException
```
    Updates the name of the layout matching the group, layout ID, and privacy.
    
    Specified by:
    
    updateName in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    name - the layout's new name
    
    languageId - the primary key of the language. For more information see Locale.
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updateName
```
public Layout updateName(long plid,
                         String name,
                         String languageId)
                  throws PortalException
```
    Updates the name of the layout matching the primary key.
    
    Specified by:
    
    updateName in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    name - the name to be assigned
    
    languageId - the primary key of the language. For more information see Locale.
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updateParentLayoutId
```
public Layout updateParentLayoutId(long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   long parentLayoutId)
                            throws PortalException
```
    Updates the parent layout ID of the layout matching the group, layout ID, and privacy.
    
    Specified by:
    
    updateParentLayoutId in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    parentLayoutId - the primary key to be assigned to the parent layout
    
    Returns:
    
    the matching layout
    
    Throws:
    
    PortalException
  - updateParentLayoutId
```
public Layout updateParentLayoutId(long plid,
                                   long parentPlid)
                            throws PortalException
```
    Updates the parent layout ID of the layout matching the primary key. If a layout matching the parent primary key is found, the layout ID of that layout is assigned, otherwise LayoutConstants#DEFAULT_PARENT_LAYOUT_ID is assigned.
    
    Specified by:
    
    updateParentLayoutId in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    parentPlid - the primary key of the parent layout
    
    Returns:
    
    the layout matching the primary key
    
    Throws:
    
    PortalException
  - updateParentLayoutIdAndPriority
```
public Layout updateParentLayoutIdAndPriority(long plid,
                                              long parentPlid,
                                              int priority)
                                       throws PortalException
```
    Updates the parent layout ID and priority of the layout.
    
    Specified by:
    
    updateParentLayoutIdAndPriority in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    parentPlid - the primary key of the parent layout
    
    priority - the layout's new priority
    
    Returns:
    
    the layout matching the primary key
    
    Throws:
    
    PortalException
  - updatePriority
```
public Layout updatePriority(long groupId,
                             boolean privateLayout,
                             long layoutId,
                             int priority)
                      throws PortalException
```
    Updates the priority of the layout matching the group, layout ID, and privacy.
    
    Specified by:
    
    updatePriority in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    priority - the layout's new priority
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updatePriority
```
public Layout updatePriority(long groupId,
                             boolean privateLayout,
                             long layoutId,
                             long nextLayoutId,
                             long previousLayoutId)
                      throws PortalException
```
    Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.
    
    Specified by:
    
    updatePriority in interface LayoutService
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the primary key of the layout
    
    nextLayoutId - the primary key of the next layout
    
    previousLayoutId - the primary key of the previous layout
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - updatePriority
```
public Layout updatePriority(long plid,
                             int priority)
                      throws PortalException
```
    Updates the priority of the layout matching the primary key.
    
    Specified by:
    
    updatePriority in interface LayoutService
    
    Parameters:
    
    plid - the primary key of the layout
    
    priority - the layout's new priority
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException
  - validateImportLayoutsFile
```
@Deprecated
public MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
                                                               File file)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.validateImportLayoutsFile( ExportImportConfiguration, File)
    
    Specified by:
    
    validateImportLayoutsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportLayoutsFile
```
@Deprecated
public MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
                                                               InputStream inputStream)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.validateImportLayoutsFile( ExportImportConfiguration, InputStream)
    
    Specified by:
    
    validateImportLayoutsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportLayoutsFile
```
@Deprecated
public MissingReferences validateImportLayoutsFile(long groupId,
                                                               boolean privateLayout,
                                                               Map<String,String[]> parameterMap,
                                                               File file)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    validateImportLayoutsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportLayoutsFile
```
@Deprecated
public MissingReferences validateImportLayoutsFile(long groupId,
                                                               boolean privateLayout,
                                                               Map<String,String[]> parameterMap,
                                                               InputStream inputStream)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    validateImportLayoutsFile in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportPortletInfo
```
@Deprecated
public MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                                               File file)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.validateImportPortletInfo( ExportImportConfiguration, File)
    
    Specified by:
    
    validateImportPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportPortletInfo
```
@Deprecated
public MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                                               InputStream inputStream)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.validateImportPortletInfo( ExportImportConfiguration, InputStream)
    
    Specified by:
    
    validateImportPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportPortletInfo
```
@Deprecated
public MissingReferences validateImportPortletInfo(long plid,
                                                               long groupId,
                                                               String portletId,
                                                               Map<String,String[]> parameterMap,
                                                               File file)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    validateImportPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - validateImportPortletInfo
```
@Deprecated
public MissingReferences validateImportPortletInfo(long plid,
                                                               long groupId,
                                                               String portletId,
                                                               Map<String,String[]> parameterMap,
                                                               InputStream inputStream)
                                                        throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), with no direct replacement
    
    Specified by:
    
    validateImportPortletInfo in interface LayoutService
    
    Throws:
    
    PortalException
  - getWrappedService
```
public LayoutService getWrappedService()
```
    Specified by:
    
    getWrappedService in interface ServiceWrapper<LayoutService>
  - setWrappedService
```
public void setWrappedService(LayoutService layoutService)
```
    Specified by:
    
    setWrappedService in interface ServiceWrapper<LayoutService>

Class LayoutServiceWrapper

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

LayoutServiceWrapper

Method Detail

addLayout

addLayout

addTempFileEntry

deleteLayout

deleteLayout

deleteTempFileEntry

exportLayouts

exportLayouts

exportLayoutsAsFile

exportLayoutsAsFile

exportLayoutsAsFileInBackground

exportLayoutsAsFileInBackground

exportLayoutsAsFileInBackground

exportLayoutsAsFileInBackground

exportPortletInfo

exportPortletInfo

exportPortletInfoAsFile

exportPortletInfoAsFile

exportPortletInfoAsFile

exportPortletInfoAsFileInBackground

exportPortletInfoAsFileInBackground

getAncestorLayouts

getDefaultPlid

getDefaultPlid

getLayoutByUuidAndGroupId

getLayoutName

getLayoutReferences

getLayouts

getLayouts

getLayouts

getLayoutsCount

getLayoutsCount

getOSGiServiceIdentifier

getTempFileNames

importLayouts

importLayouts

importLayouts

importLayouts

importLayouts

importLayoutsInBackground

importLayoutsInBackground

importPortletInfo

importPortletInfo

importPortletInfo

importPortletInfo

importPortletInfo

importPortletInfo

importPortletInfoInBackground

importPortletInfoInBackground

importPortletInfoInBackground

importPortletInfoInBackground

schedulePublishToLive

schedulePublishToLive

schedulePublishToLive

schedulePublishToRemote

setLayouts

unschedulePublishToLive

unschedulePublishToRemote

updateIconImage

updateLayout

updateLayout

updateLookAndFeel

updateName

updateName

updateParentLayoutId

updateParentLayoutId

updateParentLayoutIdAndPriority

updatePriority

updatePriority

updatePriority

validateImportLayoutsFile

validateImportLayoutsFile

validateImportLayoutsFile