LayoutServiceImpl (Liferay 7.0.10 portal-impl API)

Object
- com.liferay.portal.kernel.service.BaseServiceImpl
- - com.liferay.portal.service.base.LayoutServiceBaseImpl
  - - com.liferay.portal.service.impl.LayoutServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.LayoutService
```
public class LayoutServiceImpl
extends LayoutServiceBaseImpl
```
Provides the remote service for accessing, adding, deleting, exporting, importing, scheduling publishing of, and updating layouts. Its methods include permission checks.

Author:

Brian Wing Shun Chan, Wesley Gong, Tibor Lipusz

Field Summary
- Fields inherited from class com.liferay.portal.service.base.LayoutServiceBaseImpl
  assetCategoryFinder, assetCategoryLocalService, assetCategoryPersistence, assetCategoryService, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetEntryService, assetTagFinder, assetTagLocalService, assetTagPersistence, assetTagService, classNameLocalService, classNamePersistence, classNameService, counterLocalService, expandoRowLocalService, expandoRowPersistence, exportImportConfigurationFinder, exportImportConfigurationLocalService, exportImportConfigurationPersistence, exportImportConfigurationService, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, layoutFinder, layoutFriendlyURLLocalService, layoutFriendlyURLPersistence, layoutLocalService, layoutPersistence, layoutPrototypeLocalService, layoutPrototypePersistence, layoutPrototypeService, layoutService, layoutSetLocalService, layoutSetPersistence, layoutSetPrototypeLocalService, layoutSetPrototypePersistence, layoutSetPrototypeService, layoutSetService, pluginSettingLocalService, pluginSettingPersistence, pluginSettingService, portletPreferencesFinder, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, ratingsStatsFinder, ratingsStatsLocalService, ratingsStatsPersistence, resourceLocalService, resourcePermissionFinder, resourcePermissionLocalService, resourcePermissionPersistence, resourcePermissionService, subscriptionLocalService, subscriptionPersistence, userFinder, userGroupFinder, userGroupLocalService, userGroupPersistence, userGroupService, userLocalService, userPersistence, userService
- Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl
  ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors
Constructor and Description

LayoutServiceImpl()

Constructors
Constructor and Description
`LayoutServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`com.liferay.portal.kernel.model.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, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Adds a layout with additional parameters.
`com.liferay.portal.kernel.model.Layout`	`addLayout(long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Adds a layout with single entry maps for name, title, and description to the default locale.
`com.liferay.portal.kernel.repository.model.FileEntry`	`addTempFileEntry(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType)`
`protected void`	`checkLayoutTypeSettings(com.liferay.portal.kernel.model.Layout layout, String originalTypeSettings, String newTypeSettings)`
`void`	`deleteLayout(long groupId, boolean privateLayout, long layoutId, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.
`void`	`deleteLayout(long plid, com.liferay.portal.kernel.service.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(com.liferay.exportimport.kernel.model.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(com.liferay.exportimport.kernel.model.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(com.liferay.exportimport.kernel.model.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
`protected List<com.liferay.portal.kernel.model.Layout>`	`filterLayouts(List<com.liferay.portal.kernel.model.Layout> layouts)`
`List<com.liferay.portal.kernel.model.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)`
`com.liferay.portal.kernel.model.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.
`com.liferay.portal.kernel.model.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<com.liferay.portal.kernel.model.Layout>`	`getLayouts(long groupId, boolean privateLayout)`
`List<com.liferay.portal.kernel.model.Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId)`
`List<com.liferay.portal.kernel.model.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)`
`protected List<String>`	`getPortletIds(com.liferay.portal.kernel.model.Layout layout, String typeSettings)`
`String[]`	`getTempFileNames(long groupId, String folderName)`
`void`	`importLayouts(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.importLayouts( ExportImportConfiguration, File)`
`void`	`importLayouts(com.liferay.exportimport.kernel.model.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(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.importPortletInfo( ExportImportConfiguration, File)` (
`void`	`importPortletInfo(com.liferay.exportimport.kernel.model.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, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
`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.
`com.liferay.portal.kernel.model.Layout`	`updateIconImage(long plid, byte[] bytes)`
`com.liferay.portal.kernel.model.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, com.liferay.portal.kernel.service.ServiceContext serviceContext)` Updates the layout with additional parameters.
`com.liferay.portal.kernel.model.Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings)` Updates the layout replacing its type settings.
`com.liferay.portal.kernel.model.Layout`	`updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css)` Updates the look and feel of the layout.
`com.liferay.portal.kernel.model.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.
`com.liferay.portal.kernel.model.Layout`	`updateName(long plid, String name, String languageId)` Updates the name of the layout matching the primary key.
`com.liferay.portal.kernel.model.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.
`com.liferay.portal.kernel.model.Layout`	`updateParentLayoutId(long plid, long parentPlid)` Updates the parent layout ID of the layout matching the primary key.
`com.liferay.portal.kernel.model.Layout`	`updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority)` Updates the parent layout ID and priority of the layout.
`com.liferay.portal.kernel.model.Layout`	`updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)` Updates the priority of the layout matching the group, layout ID, and privacy.
`com.liferay.portal.kernel.model.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.
`com.liferay.portal.kernel.model.Layout`	`updatePriority(long plid, int priority)` Updates the priority of the layout matching the primary key.
`com.liferay.exportimport.kernel.lar.MissingReferences`	`validateImportLayoutsFile(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportLayoutsFile( ExportImportConfiguration, File)`
`com.liferay.exportimport.kernel.lar.MissingReferences`	`validateImportLayoutsFile(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportLayoutsFile( ExportImportConfiguration, InputStream)`
`com.liferay.exportimport.kernel.lar.MissingReferences`	`validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`com.liferay.exportimport.kernel.lar.MissingReferences`	`validateImportLayoutsFile(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`com.liferay.exportimport.kernel.lar.MissingReferences`	`validateImportPortletInfo(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportPortletInfo( ExportImportConfiguration, File)`
`com.liferay.exportimport.kernel.lar.MissingReferences`	`validateImportPortletInfo(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportService.validateImportPortletInfo( ExportImportConfiguration, InputStream)`
`com.liferay.exportimport.kernel.lar.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
`com.liferay.exportimport.kernel.lar.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 com.liferay.portal.service.base.LayoutServiceBaseImpl
afterPropertiesSet, destroy, getAssetCategoryFinder, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetCategoryService, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getAssetTagFinder, getAssetTagLocalService, getAssetTagPersistence, getAssetTagService, getClassNameLocalService, getClassNamePersistence, getClassNameService, getCounterLocalService, getExpandoRowLocalService, getExpandoRowPersistence, getExportImportConfigurationFinder, getExportImportConfigurationLocalService, getExportImportConfigurationPersistence, getExportImportConfigurationService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getLayoutFinder, getLayoutFriendlyURLLocalService, getLayoutFriendlyURLPersistence, getLayoutLocalService, getLayoutPersistence, getLayoutPrototypeLocalService, getLayoutPrototypePersistence, getLayoutPrototypeService, getLayoutService, getLayoutSetLocalService, getLayoutSetPersistence, getLayoutSetPrototypeLocalService, getLayoutSetPrototypePersistence, getLayoutSetPrototypeService, getLayoutSetService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getPluginSettingLocalService, getPluginSettingPersistence, getPluginSettingService, getPortletPreferencesFinder, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getRatingsStatsFinder, getRatingsStatsLocalService, getRatingsStatsPersistence, getResourceLocalService, getResourcePermissionFinder, getResourcePermissionLocalService, getResourcePermissionPersistence, getResourcePermissionService, getSubscriptionLocalService, getSubscriptionPersistence, getUserFinder, getUserGroupFinder, getUserGroupLocalService, getUserGroupPersistence, getUserGroupService, getUserLocalService, getUserPersistence, getUserService, runSQL, setAssetCategoryFinder, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetCategoryService, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setAssetTagFinder, setAssetTagLocalService, setAssetTagPersistence, setAssetTagService, setClassNameLocalService, setClassNamePersistence, setClassNameService, setCounterLocalService, setExpandoRowLocalService, setExpandoRowPersistence, setExportImportConfigurationFinder, setExportImportConfigurationLocalService, setExportImportConfigurationPersistence, setExportImportConfigurationService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setLayoutFinder, setLayoutFriendlyURLLocalService, setLayoutFriendlyURLPersistence, setLayoutLocalService, setLayoutPersistence, setLayoutPrototypeLocalService, setLayoutPrototypePersistence, setLayoutPrototypeService, setLayoutService, setLayoutSetLocalService, setLayoutSetPersistence, setLayoutSetPrototypeLocalService, setLayoutSetPrototypePersistence, setLayoutSetPrototypeService, setLayoutSetService, setPluginSettingLocalService, setPluginSettingPersistence, setPluginSettingService, setPortletPreferencesFinder, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setRatingsStatsFinder, setRatingsStatsLocalService, setRatingsStatsPersistence, setResourceLocalService, setResourcePermissionFinder, setResourcePermissionLocalService, setResourcePermissionPersistence, setResourcePermissionService, setSubscriptionLocalService, setSubscriptionPersistence, setUserFinder, setUserGroupFinder, setUserGroupLocalService, setUserGroupPersistence, setUserGroupService, setUserLocalService, setUserPersistence, setUserService

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

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

Constructor Detail
- LayoutServiceImpl
```
public LayoutServiceImpl()
```

Method Detail

addLayout
```
public com.liferay.portal.kernel.model.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,
                                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.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.

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:

com.liferay.portal.kernel.exception.PortalException

addLayout
```
public com.liferay.portal.kernel.model.Layout addLayout(long groupId,
                                                        boolean privateLayout,
                                                        long parentLayoutId,
                                                        String name,
                                                        String title,
                                                        String description,
                                                        String type,
                                                        boolean hidden,
                                                        String friendlyURL,
                                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                 throws com.liferay.portal.kernel.exception.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.

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:

com.liferay.portal.kernel.exception.PortalException

addTempFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry(long groupId,
                                                                             String folderName,
                                                                             String fileName,
                                                                             InputStream inputStream,
                                                                             String mimeType)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

deleteLayout
```
public void deleteLayout(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException
```
Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.

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:

com.liferay.portal.kernel.exception.PortalException

deleteLayout
```
public void deleteLayout(long plid,
                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                  throws com.liferay.portal.kernel.exception.PortalException
```
Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.

Parameters:

plid - the primary key of the layout

serviceContext - the service context to be applied

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteTempFileEntry

public void deleteTempFileEntry(long groupId,
                                String folderName,
                                String fileName)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

exportLayouts
```
@Deprecated
public byte[] exportLayouts(long groupId,
                                        boolean privateLayout,
                                        long[] layoutIds,
                                        Map<String,String[]> parameterMap,
                                        Date startDate,
                                        Date endDate)
                                 throws com.liferay.portal.kernel.exception.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.

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:

com.liferay.portal.kernel.exception.PortalException

exportLayouts
```
@Deprecated
public byte[] exportLayouts(long groupId,
                                        boolean privateLayout,
                                        Map<String,String[]> parameterMap,
                                        Date startDate,
                                        Date endDate)
                                 throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Exports all layouts that match the criteria as a byte array.

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:

com.liferay.portal.kernel.exception.PortalException

exportLayoutsAsFile

@Deprecated
public File exportLayoutsAsFile(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration)
                                     throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.exportLayoutsAsFile(
             ExportImportConfiguration)

Throws:: com.liferay.portal.kernel.exception.PortalException

exportLayoutsAsFile
```
@Deprecated
public File exportLayoutsAsFile(long groupId,
                                            boolean privateLayout,
                                            long[] layoutIds,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate)
                                     throws com.liferay.portal.kernel.exception.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.

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:

com.liferay.portal.kernel.exception.PortalException

exportLayoutsAsFileInBackground

@Deprecated
public long exportLayoutsAsFileInBackground(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.exportLayoutsAsFileInBackground(
             ExportImportConfiguration)

Throws:: com.liferay.portal.kernel.exception.PortalException

exportLayoutsAsFileInBackground
```
@Deprecated
public long exportLayoutsAsFileInBackground(long exportImportConfigurationId)
                                                 throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportService.exportLayoutsAsFileInBackground( long)

Throws:

com.liferay.portal.kernel.exception.PortalException

exportLayoutsAsFileInBackground

@Deprecated
public long exportLayoutsAsFileInBackground(String taskName,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        long[] layoutIds,
                                                        Map<String,String[]> parameterMap,
                                                        Date startDate,
                                                        Date endDate)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

exportPortletInfo
```
@Deprecated
public byte[] exportPortletInfo(long plid,
                                            long groupId,
                                            String portletId,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate)
                                     throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Exports the portlet information (categories, permissions, ... etc.) as a byte array.

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:

com.liferay.portal.kernel.exception.PortalException

exportPortletInfo

@Deprecated
public byte[] exportPortletInfo(long companyId,
                                            String portletId,
                                            Map<String,String[]> parameterMap,
                                            Date startDate,
                                            Date endDate)
                                     throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

exportPortletInfoAsFile

@Deprecated
public File exportPortletInfoAsFile(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration)
                                         throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.exportPortletInfoAsFile(
             ExportImportConfiguration)

Throws:: com.liferay.portal.kernel.exception.PortalException

exportPortletInfoAsFile
```
@Deprecated
public File exportPortletInfoAsFile(long plid,
                                                long groupId,
                                                String portletId,
                                                Map<String,String[]> parameterMap,
                                                Date startDate,
                                                Date endDate)
                                         throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Exports the portlet information (categories, permissions, ... etc.) as a file.

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:

com.liferay.portal.kernel.exception.PortalException

exportPortletInfoAsFile

@Deprecated
public File exportPortletInfoAsFile(String portletId,
                                                Map<String,String[]> parameterMap,
                                                Date startDate,
                                                Date endDate)
                                         throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

exportPortletInfoAsFileInBackground

@Deprecated
public long exportPortletInfoAsFileInBackground(String taskName,
                                                            String portletId,
                                                            Map<String,String[]> parameterMap,
                                                            Date startDate,
                                                            Date endDate,
                                                            String fileName)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

getAncestorLayouts
```
public List<com.liferay.portal.kernel.model.Layout> getAncestorLayouts(long plid)
                                                                throws com.liferay.portal.kernel.exception.PortalException
```
Returns all the ancestor layouts of the layout.

Parameters:

plid - the primary key of the layout

Returns:

the ancestor layouts of the layout

Throws:

com.liferay.portal.kernel.exception.PortalException

getDefaultPlid
```
public long getDefaultPlid(long groupId,
                           long scopeGroupId,
                           boolean privateLayout,
                           String portletId)
                    throws com.liferay.portal.kernel.exception.PortalException
```
Returns the primary key of the default layout for the group.

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:

com.liferay.portal.kernel.exception.PortalException

getDefaultPlid

@ThreadLocalCachable
public long getDefaultPlid(long groupId,
                                                long scopeGroupId,
                                                String portletId)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

getLayoutByUuidAndGroupId

public com.liferay.portal.kernel.model.Layout getLayoutByUuidAndGroupId(String uuid,
                                                                        long groupId,
                                                                        boolean privateLayout)
                                                                 throws com.liferay.portal.kernel.exception.PortalException

Returns the layout matching the UUID, group, and privacy.

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:: com.liferay.portal.kernel.exception.PortalException

getLayoutName
```
public String getLayoutName(long groupId,
                            boolean privateLayout,
                            long layoutId,
                            String languageId)
                     throws com.liferay.portal.kernel.exception.PortalException
```
Returns the name of the layout.

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:

com.liferay.portal.kernel.exception.PortalException

getLayoutReferences

public com.liferay.portal.kernel.model.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.

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<com.liferay.portal.kernel.model.Layout> getLayouts(long groupId,
                                                               boolean privateLayout)

getLayouts

public List<com.liferay.portal.kernel.model.Layout> getLayouts(long groupId,
                                                               boolean privateLayout,
                                                               long parentLayoutId)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

getLayouts

public List<com.liferay.portal.kernel.model.Layout> getLayouts(long groupId,
                                                               boolean privateLayout,
                                                               long parentLayoutId,
                                                               boolean incomplete,
                                                               int start,
                                                               int end)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

getLayoutsCount

public int getLayoutsCount(long groupId,
                           boolean privateLayout,
                           long parentLayoutId)

getLayoutsCount

public int getLayoutsCount(long groupId,
                           boolean privateLayout,
                           long parentLayoutId,
                           int priority)

getTempFileNames

public String[] getTempFileNames(long groupId,
                                 String folderName)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

importLayouts

@Deprecated
public void importLayouts(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                      File file)
                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.importLayouts(
             ExportImportConfiguration, File)

Throws:: com.liferay.portal.kernel.exception.PortalException

importLayouts

@Deprecated
public void importLayouts(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                      InputStream is)
                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.importLayouts(
             ExportImportConfiguration, InputStream)

Throws:: com.liferay.portal.kernel.exception.PortalException

importLayouts
```
@Deprecated
public void importLayouts(long groupId,
                                      boolean privateLayout,
                                      Map<String,String[]> parameterMap,
                                      byte[] bytes)
                               throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Imports the layouts from the byte array.

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:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Imports the layouts from the file.

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:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Imports the layouts from the input stream.

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:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importLayoutsInBackground

@Deprecated
public long importLayoutsInBackground(String taskName,
                                                  long groupId,
                                                  boolean privateLayout,
                                                  Map<String,String[]> parameterMap,
                                                  InputStream inputStream)
                                           throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfo

@Deprecated
public void importPortletInfo(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                          File file)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.importPortletInfo(
             ExportImportConfiguration, File)

(

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfo

@Deprecated
public void importPortletInfo(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                          InputStream is)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.importPortletInfo(
             ExportImportConfiguration, InputStream)

(

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfo
```
@Deprecated
public void importPortletInfo(long plid,
                                          long groupId,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          File file)
                                   throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Imports the portlet information (categories, permissions, ... etc.) from the file.

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:

com.liferay.portal.kernel.exception.PortalException

importPortletInfo
```
@Deprecated
public void importPortletInfo(long plid,
                                          long groupId,
                                          String portletId,
                                          Map<String,String[]> parameterMap,
                                          InputStream is)
                                   throws com.liferay.portal.kernel.exception.PortalException
```
Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Imports the portlet information (categories, permissions, ... etc.) from the input stream.

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:

com.liferay.portal.kernel.exception.PortalException

importPortletInfo

@Deprecated
public void importPortletInfo(String portletId,
                                          Map<String,String[]> parameterMap,
                                          File file)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfo

@Deprecated
public void importPortletInfo(String portletId,
                                          Map<String,String[]> parameterMap,
                                          InputStream is)
                                   throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfoInBackground

@Deprecated
public long importPortletInfoInBackground(String taskName,
                                                      long plid,
                                                      long groupId,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      File file)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfoInBackground

@Deprecated
public long importPortletInfoInBackground(String taskName,
                                                      long plid,
                                                      long groupId,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      InputStream is)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfoInBackground

@Deprecated
public void importPortletInfoInBackground(String taskName,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      File file)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

importPortletInfoInBackground

@Deprecated
public void importPortletInfoInBackground(String taskName,
                                                      String portletId,
                                                      Map<String,String[]> parameterMap,
                                                      InputStream is)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.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.

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:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException
```
Schedules a range of layouts to be published.

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:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.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.

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:

com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.PortalException

Schedules a range of layouts to be stored.

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:: com.liferay.portal.kernel.exception.PortalException

setLayouts
```
public void setLayouts(long groupId,
                       boolean privateLayout,
                       long parentLayoutId,
                       long[] layoutIds,
                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                throws com.liferay.portal.kernel.exception.PortalException
```
Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.

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:

com.liferay.portal.kernel.exception.PortalException

unschedulePublishToLive
```
public void unschedulePublishToLive(long groupId,
                                    String jobName,
                                    String groupName)
                             throws com.liferay.portal.kernel.exception.PortalException
```
Deletes the job from the scheduler's queue.

Parameters:

groupId - the primary key of the group

jobName - the job name

groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

Throws:

com.liferay.portal.kernel.exception.PortalException

unschedulePublishToRemote
```
public void unschedulePublishToRemote(long groupId,
                                      String jobName,
                                      String groupName)
                               throws com.liferay.portal.kernel.exception.PortalException
```
Deletes the job from the scheduler's persistent queue.

Parameters:

groupId - the primary key of the group

jobName - the job name

groupName - the group name (optionally DestinationNames.LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

Throws:

com.liferay.portal.kernel.exception.PortalException

updateIconImage

public com.liferay.portal.kernel.model.Layout updateIconImage(long plid,
                                                              byte[] bytes)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

updateLayout

public com.liferay.portal.kernel.model.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,
                                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                    throws com.liferay.portal.kernel.exception.PortalException

Updates the layout with additional parameters.

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:: com.liferay.portal.kernel.exception.PortalException

updateLayout

public com.liferay.portal.kernel.model.Layout updateLayout(long groupId,
                                                           boolean privateLayout,
                                                           long layoutId,
                                                           String typeSettings)
                                                    throws com.liferay.portal.kernel.exception.PortalException

Updates the layout replacing its type settings.

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:: com.liferay.portal.kernel.exception.PortalException

updateLookAndFeel

public com.liferay.portal.kernel.model.Layout updateLookAndFeel(long groupId,
                                                                boolean privateLayout,
                                                                long layoutId,
                                                                String themeId,
                                                                String colorSchemeId,
                                                                String css)
                                                         throws com.liferay.portal.kernel.exception.PortalException

Updates the look and feel of the layout.

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:: com.liferay.portal.kernel.exception.PortalException

updateName

public com.liferay.portal.kernel.model.Layout updateName(long groupId,
                                                         boolean privateLayout,
                                                         long layoutId,
                                                         String name,
                                                         String languageId)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Updates the name of the layout matching the group, layout ID, and privacy.

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:: com.liferay.portal.kernel.exception.PortalException

updateName

public com.liferay.portal.kernel.model.Layout updateName(long plid,
                                                         String name,
                                                         String languageId)
                                                  throws com.liferay.portal.kernel.exception.PortalException

Updates the name of the layout matching the primary key.

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:: com.liferay.portal.kernel.exception.PortalException

updateParentLayoutId

public com.liferay.portal.kernel.model.Layout updateParentLayoutId(long groupId,
                                                                   boolean privateLayout,
                                                                   long layoutId,
                                                                   long parentLayoutId)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Updates the parent layout ID of the layout matching the group, layout ID, and privacy.

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:: com.liferay.portal.kernel.exception.PortalException

updateParentLayoutId
```
public com.liferay.portal.kernel.model.Layout updateParentLayoutId(long plid,
                                                                   long parentPlid)
                                                            throws com.liferay.portal.kernel.exception.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.

Parameters:

plid - the primary key of the layout

parentPlid - the primary key of the parent layout

Returns:

the layout matching the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException

updateParentLayoutIdAndPriority

public com.liferay.portal.kernel.model.Layout updateParentLayoutIdAndPriority(long plid,
                                                                              long parentPlid,
                                                                              int priority)
                                                                       throws com.liferay.portal.kernel.exception.PortalException

Updates the parent layout ID and priority of the layout.

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:: com.liferay.portal.kernel.exception.PortalException

updatePriority

public com.liferay.portal.kernel.model.Layout updatePriority(long groupId,
                                                             boolean privateLayout,
                                                             long layoutId,
                                                             int priority)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Updates the priority of the layout matching the group, layout ID, and privacy.

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:: com.liferay.portal.kernel.exception.PortalException

updatePriority

public com.liferay.portal.kernel.model.Layout updatePriority(long groupId,
                                                             boolean privateLayout,
                                                             long layoutId,
                                                             long nextLayoutId,
                                                             long previousLayoutId)
                                                      throws com.liferay.portal.kernel.exception.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.

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:: com.liferay.portal.kernel.exception.PortalException

updatePriority

public com.liferay.portal.kernel.model.Layout updatePriority(long plid,
                                                             int priority)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Updates the priority of the layout matching the primary key.

Parameters:: plid - the primary key of the layout; priority - the layout's new priority
Returns:: the updated layout
Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportLayoutsFile

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportLayoutsFile(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                                                                                   File file)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.validateImportLayoutsFile(
             ExportImportConfiguration, File)

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportLayoutsFile

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportLayoutsFile(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                                                                                   InputStream inputStream)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.validateImportLayoutsFile(
             ExportImportConfiguration, InputStream)

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportLayoutsFile

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportLayoutsFile(long groupId,
                                                                                                   boolean privateLayout,
                                                                                                   Map<String,String[]> parameterMap,
                                                                                                   File file)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportLayoutsFile

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportLayoutsFile(long groupId,
                                                                                                   boolean privateLayout,
                                                                                                   Map<String,String[]> parameterMap,
                                                                                                   InputStream inputStream)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportPortletInfo

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportPortletInfo(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                                                                                   File file)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.validateImportPortletInfo(
             ExportImportConfiguration, File)

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportPortletInfo

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportPortletInfo(com.liferay.exportimport.kernel.model.ExportImportConfiguration exportImportConfiguration,
                                                                                                   InputStream inputStream)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

ExportImportService.validateImportPortletInfo(
             ExportImportConfiguration, InputStream)

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportPortletInfo

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportPortletInfo(long plid,
                                                                                                   long groupId,
                                                                                                   String portletId,
                                                                                                   Map<String,String[]> parameterMap,
                                                                                                   File file)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

validateImportPortletInfo

@Deprecated
public com.liferay.exportimport.kernel.lar.MissingReferences validateImportPortletInfo(long plid,
                                                                                                   long groupId,
                                                                                                   String portletId,
                                                                                                   Map<String,String[]> parameterMap,
                                                                                                   InputStream inputStream)
                                                                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: com.liferay.portal.kernel.exception.PortalException

checkLayoutTypeSettings

protected void checkLayoutTypeSettings(com.liferay.portal.kernel.model.Layout layout,
                                       String originalTypeSettings,
                                       String newTypeSettings)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

filterLayouts

protected List<com.liferay.portal.kernel.model.Layout> filterLayouts(List<com.liferay.portal.kernel.model.Layout> layouts)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:: com.liferay.portal.kernel.exception.PortalException

getPortletIds

protected List<String> getPortletIds(com.liferay.portal.kernel.model.Layout layout,
                                     String typeSettings)

Class LayoutServiceImpl

Field Summary

Fields inherited from class com.liferay.portal.service.base.LayoutServiceBaseImpl

Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

Constructor Summary

Method Summary

Methods inherited from class com.liferay.portal.service.base.LayoutServiceBaseImpl

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

Methods inherited from class Object

Constructor Detail

LayoutServiceImpl

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

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