LayoutLocalService (Liferay 7.1.0-ga1 portal-kernel API)

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

LayoutLocalServiceWrapper
```
@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LayoutLocalService
extends BaseLocalService, PersistedModelLocalService
```
Provides the local service interface for Layout. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

LayoutLocalServiceUtil, LayoutLocalServiceBaseImpl, LayoutLocalServiceImpl

{$generated.description}

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Layout`	`addLayout(Layout layout)` Adds the layout to the database.
`Layout`	`addLayout(long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, 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 userId, 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.
`Layout`	`createLayout(long plid)` Creates a new layout with the primary key.
`Layout`	`deleteLayout(Layout layout)` Deletes the layout from the database.
`void`	`deleteLayout(Layout layout, boolean updateLayoutSet, ServiceContext serviceContext)` Deletes the layout, its child layouts, and its associated resources.
`Layout`	`deleteLayout(long plid)` Deletes the layout with the primary key from the database.
`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`	`deleteLayouts(long groupId, boolean privateLayout, ServiceContext serviceContext)` Deletes the group's private or non-private layouts, also deleting the layouts' child layouts, and associated resources.
`PersistedModel`	`deletePersistedModel(PersistedModel persistedModel)`
`DynamicQuery`	`dynamicQuery()`
`<T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`<T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`<T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows matching the dynamic query.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows matching the dynamic query.
`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 `ExportImportLocalService.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(long userId, ExportImportConfiguration exportImportConfiguration)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.exportLayoutsAsFileInBackground( long, ExportImportConfiguration)`
`long`	`exportLayoutsAsFileInBackground(long userId, long exportImportConfigurationId)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.exportLayoutsAsFileInBackground( long, long)`
`long`	`exportLayoutsAsFileInBackground(long userId, 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(long userId, 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 `ExportImportLocalService.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(long companyId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`exportPortletInfoAsFileInBackground(long userId, ExportImportConfiguration exportImportConfiguration)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.exportPortletInfoAsFileInBackground( long, ExportImportConfiguration)`}
`long`	`exportPortletInfoAsFileInBackground(long userId, long exportImportConfigurationId)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.exportPortletInfoAsFileInBackground( long, long)`}
`long`	`exportPortletInfoAsFileInBackground(long userId, 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(long userId, 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
`Layout`	`fetchDefaultLayout(long groupId, boolean privateLayout)`
`Layout`	`fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId)`
`Layout`	`fetchLayout(long plid)`
`Layout`	`fetchLayout(long groupId, boolean privateLayout, long layoutId)`
`Layout`	`fetchLayout(String uuid, long groupId, boolean privateLayout)`
`Layout`	`fetchLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL)`
`Layout`	`fetchLayoutByIconImageId(boolean privateLayout, long iconImageId)`
`Layout`	`fetchLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)` Returns the layout matching the UUID, group, and privacy.
`ActionableDynamicQuery`	`getActionableDynamicQuery()`
`long`	`getDefaultPlid(long groupId)` Returns the primary key of the default layout for the group.
`long`	`getDefaultPlid(long groupId, boolean privateLayout)` Returns primary key of the matching default layout for the group
`long`	`getDefaultPlid(long groupId, boolean privateLayout, String portletId)` Returns primary key of the default portlet layout for the group
`ExportActionableDynamicQuery`	`getExportActionableDynamicQuery(PortletDataContext portletDataContext)`
`Layout`	`getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL)` Returns the layout for the friendly URL.
`IndexableActionableDynamicQuery`	`getIndexableActionableDynamicQuery()`
`Layout`	`getLayout(long plid)` Returns the layout with the primary key.
`Layout`	`getLayout(long groupId, boolean privateLayout, long layoutId)` Returns the layout matching the primary key, group, and privacy; throws a `NoSuchLayoutException` otherwise.
`Layout`	`getLayoutByIconImageId(long iconImageId)` Returns the layout for the icon image; throws a `NoSuchLayoutException` otherwise.
`Layout`	`getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)` Returns the layout matching the UUID, group, and privacy.
`Map<Long,List<Layout>>`	`getLayoutChildLayouts(LayoutSet layoutSet, List<Layout> parentLayouts)`
`List<Layout>`	`getLayouts(int start, int end)` Returns a range of all the layouts.
`List<Layout>`	`getLayouts(long companyId)`
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout)` Returns all the layouts belonging to the group.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, int start, int end, OrderByComparator<Layout> obc)` Returns a range of all the layouts belonging to the group.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId)` Returns all the layouts belonging to the group that are children of the parent layout.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long[] layoutIds)` Returns all the layouts that match the layout IDs and belong to the group.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)` Returns a range of all the layouts belonging to the group that are children of the parent layout.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end, OrderByComparator<Layout> obc)` Returns a range of all the layouts belonging to the group that are children of the parent layout.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, String type)` Returns all the layouts that match the type and belong to the group.
`LayoutReference[]`	`getLayouts(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>`	`getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)`
`int`	`getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)`
`List<Layout>`	`getLayoutsByUuidAndCompanyId(String uuid, long companyId)` Returns all the layouts matching the UUID and company.
`List<Layout>`	`getLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Layout> orderByComparator)` Returns a range of layouts matching the UUID and company.
`int`	`getLayoutsCount()` Returns the number of layouts.
`int`	`getLayoutsCount(Group group, boolean privateLayout)`
`int`	`getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups)`
`int`	`getLayoutsCount(Group group, boolean privateLayout, long parentLayoutId)`
`int`	`getLayoutsCount(Group group, boolean privateLayout, long[] layoutIds)`
`int`	`getLayoutsCount(User user, boolean privateLayout)`
`int`	`getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups)`
`long`	`getNextLayoutId(long groupId, boolean privateLayout)` Returns the primary key to use for the next layout.
`List<Layout>`	`getNoPermissionLayouts(long roleId)` Deprecated. As of Judson (7.1.x), with no direct replacement
`List<Layout>`	`getNullFriendlyURLLayouts()` Deprecated. As of Judson (7.1.x), with no direct replacement
`String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`Layout`	`getParentLayout(Layout layout)`
`PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`List<Layout>`	`getScopeGroupLayouts(long parentGroupId)`
`List<Layout>`	`getScopeGroupLayouts(long parentGroupId, boolean privateLayout)` Returns all the layouts within scope of the group.
`boolean`	`hasLayout(String uuid, long groupId, boolean privateLayout)` Returns `true` if there is a matching layout with the UUID, group, and privacy.
`boolean`	`hasLayouts(Group group)`
`boolean`	`hasLayouts(Group group, boolean privateLayout)`
`boolean`	`hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups)`
`boolean`	`hasLayouts(long groupId, boolean privateLayout, long parentLayoutId)` Returns `true` if the group has any layouts; `false` otherwise.
`boolean`	`hasLayouts(User user, boolean privateLayout)`
`boolean`	`hasLayouts(User user, boolean privateLayout, boolean includeUserGroups)`
`boolean`	`hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid)`
`boolean`	`hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, long companyId, String layoutUuid)`
`void`	`importLayouts(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importLayouts( ExportImportConfiguration, File)`}
`void`	`importLayouts(ExportImportConfiguration exportImportConfiguration, InputStream is)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importLayouts( ExportImportConfiguration, InputStream)`}
`void`	`importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importLayouts(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importLayoutsDataDeletions(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importLayoutsDataDeletions( ExportImportConfiguration, File)`
`long`	`importLayoutsInBackground(long userId, ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importLayoutsInBackground( long, ExportImportConfiguration, File)`
`long`	`importLayoutsInBackground(long userId, long exportImportConfigurationId, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importLayoutsInBackground( long, long, File)`
`long`	`importLayoutsInBackground(long userId, 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(long userId, String taskName, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletDataDeletions(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importPortletDataDeletions( ExportImportConfiguration, File)`
`void`	`importPortletInfo(ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importPortletInfo( ExportImportConfiguration, File)`
`void`	`importPortletInfo(ExportImportConfiguration exportImportConfiguration, InputStream is)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importPortletInfo( ExportImportConfiguration, InputStream)`
`void`	`importPortletInfo(long userId, 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 userId, 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(long userId, String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`importPortletInfo(long userId, String portletId, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`importPortletInfoInBackground(long userId, ExportImportConfiguration exportImportConfiguration, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importPortletInfoInBackground( long, ExportImportConfiguration, File)`
`long`	`importPortletInfoInBackground(long userId, long exportImportConfigurationId, File file)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.importPortletInfoInBackground( long, long, File)`
`long`	`importPortletInfoInBackground(long userId, 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(long userId, 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
`long`	`importPortletInfoInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`long`	`importPortletInfoInBackground(long userId, String taskName, String portletId, Map<String,String[]> parameterMap, InputStream is)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`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`	`updateAsset(long userId, Layout layout, long[] assetCategoryIds, String[] assetTagNames)`
`Layout`	`updateFriendlyURL(long userId, long plid, String friendlyURL, String languageId)` Updates the friendly URL of the layout.
`Layout`	`updateFriendlyURL(long plid, String friendlyURL, String languageId)` Deprecated. As of Wilberforce (7.0.x), replaced by `updateFriendlyURL(long, long, String, String)`
`Layout`	`updateIconImage(long plid, byte[] bytes)`
`Layout`	`updateLayout(Layout layout)` Updates the layout in the database or adds it if it does not yet exist.
`Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale,String> nameMap, Map<Locale,String> titleMap, 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.
`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(Layout layout, String name, String languageId)` Updates the name 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.
`void`	`updatePriorities(long groupId, boolean privateLayout)` Updates the priorities of the layouts.
`Layout`	`updatePriority(Layout layout, int priority)` Updates the 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 `ExportImportLocalService.validateImportLayoutsFile( ExportImportConfiguration, File)`
`MissingReferences`	`validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.validateImportLayoutsFile( ExportImportConfiguration, InputStream)`
`MissingReferences`	`validateImportLayoutsFile(long userId, long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`MissingReferences`	`validateImportLayoutsFile(long userId, 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 `ExportImportLocalService.validateImportPortletInfo( ExportImportConfiguration, File)`
`MissingReferences`	`validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), replaced by `ExportImportLocalService.validateImportPortletInfo( ExportImportConfiguration, InputStream)`
`MissingReferences`	`validateImportPortletInfo(long userId, 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 userId, long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream inputStream)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Method Detail

addLayout
```
@Indexable(type=REINDEX)
Layout addLayout(Layout layout)
```
Adds the layout to the database. Also notifies the appropriate model listeners.

Parameters:

layout - the layout

Returns:

the layout that was added

addLayout
```
Layout addLayout(long userId,
                 long groupId,
                 boolean privateLayout,
                 long parentLayoutId,
                 Map<Locale,String> nameMap,
                 Map<Locale,String> titleMap,
                 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.

Parameters:

userId - the primary key of the user

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)

nameMap - the layout's locales and localized names

titleMap - 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 set to specify whether site administrators can modify this page within their site. For layouts that are created from a layout prototype, attributes named layoutPrototypeUuid and layoutPrototypeLinkedEnabled can be specified to provide the unique identifier of the source prototype and a boolean to determine whether a link to it should be enabled to activate propagation of changes made to the linked page in the prototype.

Returns:

the layout

Throws:

PortalException - if a portal exception occurred

addLayout
```
Layout addLayout(long userId,
                 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.

Parameters:

userId - the primary key of the user

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). The possible values can be found in LayoutConstants.

name - the layout's name (optionally PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_NAME or PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_NAME). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues

title - the layout's title

description - the layout's description

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 friendly URL of the layout (optionally PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. 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 and modification date for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be set to specify whether site administrators can modify this page within their site.

Returns:

the layout

Throws:

PortalException - if a portal exception occurred

createLayout
```
@Transactional(enabled=false)
Layout createLayout(long plid)
```
Creates a new layout with the primary key. Does not add the layout to the database.

Parameters:

plid - the primary key for the new layout

Returns:

the new layout

deleteLayout
```
@Indexable(type=DELETE)
Layout deleteLayout(Layout layout)
                                     throws PortalException
```
Deletes the layout from the database. Also notifies the appropriate model listeners.

Parameters:

layout - the layout

Returns:

the layout that was removed

Throws:

PortalException

deleteLayout

@SystemEvent(action=1,
             type=1)
void deleteLayout(Layout layout,
                                                              boolean updateLayoutSet,
                                                              ServiceContext serviceContext)
                                                       throws PortalException

Deletes the layout, its child layouts, and its associated resources.

Parameters:: layout - the layout; updateLayoutSet - whether the layout set's page counter needs to be updated; serviceContext - the service context to be applied
Throws:: PortalException - if a portal exception occurred

deleteLayout
```
@Indexable(type=DELETE)
Layout deleteLayout(long plid)
                                     throws PortalException
```
Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

plid - the primary key of the layout

Returns:

the layout that was removed

Throws:

PortalException - if a layout with the primary key could not be found

deleteLayout
```
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.

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 - if a portal exception occurred

deleteLayout
```
void deleteLayout(long plid,
                  ServiceContext serviceContext)
           throws 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:

PortalException - if a portal exception occurred

deleteLayouts
```
void deleteLayouts(long groupId,
                   boolean privateLayout,
                   ServiceContext serviceContext)
            throws PortalException
```
Deletes the group's private or non-private layouts, also deleting the layouts' child layouts, and associated resources.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

serviceContext - the service context to be applied. The parent layout set's page count will be updated by default, unless an attribute named updatePageCount is set to false.

Throws:

PortalException - if a portal exception occurred

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:: deletePersistedModel in interface PersistedModelLocalService
Throws:: PortalException

dynamicQuery
```
DynamicQuery dynamicQuery()
```

dynamicQuery
```
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
```
Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery
```
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
```
Performs a dynamic query on the database and returns a range of the matching rows.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery
```
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)
```
Performs a dynamic query on the database and returns an ordered range of the matching rows.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount
```
long dynamicQueryCount(DynamicQuery dynamicQuery)
```
Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount
```
long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
```
Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

exportLayouts
```
@Deprecated
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 layouts with the primary keys and 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:

PortalException

exportLayouts
```
@Deprecated
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.

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
File exportLayoutsAsFile(ExportImportConfiguration exportImportConfiguration)
                              throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportLocalService.exportLayoutsAsFile( ExportImportConfiguration)

Throws:

PortalException

exportLayoutsAsFile
```
@Deprecated
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 the 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:

PortalException

exportLayoutsAsFileInBackground

@Deprecated
long exportLayoutsAsFileInBackground(long userId,
                                                 ExportImportConfiguration exportImportConfiguration)
                                          throws PortalException

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

ExportImportLocalService.exportLayoutsAsFileInBackground(
	long, ExportImportConfiguration)

Throws:: PortalException

exportLayoutsAsFileInBackground

@Deprecated
long exportLayoutsAsFileInBackground(long userId,
                                                 long exportImportConfigurationId)
                                          throws PortalException

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

ExportImportLocalService.exportLayoutsAsFileInBackground(
	long, long)

Throws:: PortalException

exportLayoutsAsFileInBackground

@Deprecated
long exportLayoutsAsFileInBackground(long userId,
                                                 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

Throws:: PortalException

exportLayoutsAsFileInBackground

@Deprecated
long exportLayoutsAsFileInBackground(long userId,
                                                 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

Throws:: PortalException

exportPortletInfo
```
@Deprecated
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.

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
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

Throws:: PortalException

exportPortletInfoAsFile
```
@Deprecated
File exportPortletInfoAsFile(ExportImportConfiguration exportImportConfiguration)
                                  throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by ExportImportLocalService.exportPortletInfoAsFile( ExportImportConfiguration)}

Throws:

PortalException

exportPortletInfoAsFile
```
@Deprecated
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.

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
File exportPortletInfoAsFile(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

Throws:: PortalException

exportPortletInfoAsFileInBackground

@Deprecated
long exportPortletInfoAsFileInBackground(long userId,
                                                     ExportImportConfiguration exportImportConfiguration)
                                              throws PortalException

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

ExportImportLocalService.exportPortletInfoAsFileInBackground(
	long, ExportImportConfiguration)

}

Throws:: PortalException

exportPortletInfoAsFileInBackground

@Deprecated
long exportPortletInfoAsFileInBackground(long userId,
                                                     long exportImportConfigurationId)
                                              throws PortalException

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

ExportImportLocalService.exportPortletInfoAsFileInBackground(
	long, long)

}

Throws:: PortalException

exportPortletInfoAsFileInBackground

@Deprecated
long exportPortletInfoAsFileInBackground(long userId,
                                                     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

Throws:: PortalException

exportPortletInfoAsFileInBackground

@Deprecated
long exportPortletInfoAsFileInBackground(long userId,
                                                     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

Throws:: PortalException

fetchDefaultLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchDefaultLayout(long groupId,
                                                                                             boolean privateLayout)

fetchFirstLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchFirstLayout(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long parentLayoutId)

fetchLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchLayout(long plid)

fetchLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchLayout(long groupId,
                                                                                      boolean privateLayout,
                                                                                      long layoutId)

fetchLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchLayout(String uuid,
                                                                                      long groupId,
                                                                                      boolean privateLayout)

fetchLayoutByFriendlyURL

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchLayoutByFriendlyURL(long groupId,
                                                                                                   boolean privateLayout,
                                                                                                   String friendlyURL)

fetchLayoutByIconImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchLayoutByIconImageId(boolean privateLayout,
                                                                                                   long iconImageId)
                                                                                            throws PortalException

Throws:: PortalException

fetchLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchLayoutByUuidAndGroupId(String uuid,
                                                                                                      long groupId,
                                                                                                      boolean privateLayout)

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, or null if a matching layout could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDefaultPlid
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getDefaultPlid(long groupId)
```
Returns the primary key of the default layout for the group.

Parameters:

groupId - the primary key of the group

Returns:

the primary key of the default layout for the group (optionally LayoutConstants#DEFAULT_PLID)

getDefaultPlid
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getDefaultPlid(long groupId,
                                                                                       boolean privateLayout)
```
Returns primary key of the matching default layout for the group

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

Returns:

the primary key of the default layout for the group; LayoutConstants#DEFAULT_PLID) otherwise

getDefaultPlid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getDefaultPlid(long groupId,
                                                                                       boolean privateLayout,
                                                                                       String portletId)
                                                                                throws PortalException

Returns primary key of the default portlet layout for the group

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group; portletId - the primary key of the portlet
Returns:: the primary key of the default portlet layout for the group; LayoutConstants#DEFAULT_PLID otherwise
Throws:: PortalException

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFriendlyURLLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getFriendlyURLLayout(long groupId,
                                                                                               boolean privateLayout,
                                                                                               String friendlyURL)
                                                                                        throws PortalException

Returns the layout for the friendly URL.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group; friendlyURL - the friendly URL of the layout
Returns:: the layout for the friendly URL
Throws:: PortalException - if a portal exception occurred

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getLayout(long plid)
                                                                             throws PortalException

Returns the layout with the primary key.

Parameters:: plid - the primary key of the layout
Returns:: the layout
Throws:: PortalException - if a layout with the primary key could not be found

getLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getLayout(long groupId,
                                                                                    boolean privateLayout,
                                                                                    long layoutId)
                                                                             throws PortalException

Returns the layout matching the primary key, group, and privacy; throws a NoSuchLayoutException otherwise.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group; layoutId - the primary key of the layout
Returns:: the matching layout
Throws:: PortalException - if a portal exception occurred

getLayoutByIconImageId
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getLayoutByIconImageId(long iconImageId)
                                                                                          throws PortalException
```
Returns the layout for the icon image; throws a NoSuchLayoutException otherwise.

Parameters:

iconImageId - the primary key of the icon image

Returns:

Returns the layout for the icon image

Throws:

PortalException - if a portal exception occurred

getLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getLayoutByUuidAndGroupId(String uuid,
                                                                                                    long groupId,
                                                                                                    boolean privateLayout)
                                                                                             throws 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:: PortalException - if a matching layout could not be found

getLayoutChildLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,List<Layout>> getLayoutChildLayouts(LayoutSet layoutSet,
                                                                                                                List<Layout> parentLayouts)

getLayouts
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(int start,
                                                                                           int end)
```
Returns a range of all the layouts.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of layouts

end - the upper bound of the range of layouts (not inclusive)

Returns:

the range of layouts

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long companyId)

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout)

Returns all the layouts belonging to the group.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group
Returns:: the matching layouts, or null if no matches were found

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Layout> obc)

Returns a range of all the layouts belonging to the group.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group; start - the lower bound of the range of layouts; end - the upper bound of the range of layouts (not inclusive); obc - the comparator to order the layouts
Returns:: the matching layouts, or null if no matches were found

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long parentLayoutId)

Returns all the layouts belonging to the group that are children 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
Returns:: the matching layouts, or null if no matches were found

getLayouts
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long parentLayoutId,
                                                                                           boolean incomplete,
                                                                                           int start,
                                                                                           int end)
```
Returns a range of all the layouts belonging to the group that are children of the parent layout.
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

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

incomplete - whether the layout is incomplete

start - the lower bound of the range of layouts

end - the upper bound of the range of layouts (not inclusive)

Returns:

the matching layouts, or null if no matches were found

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long parentLayoutId,
                                                                                           boolean incomplete,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Layout> obc)

Returns a range of all the layouts belonging to the group that are children of the parent layout.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

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; start - the lower bound of the range of layouts; end - the upper bound of the range of layouts (not inclusive); obc - the comparator to order the layouts
Returns:: the matching layouts, or null if no matches were found

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long[] layoutIds)
                                                                                    throws PortalException

Returns all the layouts that match the layout IDs and belong to the group.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group; layoutIds - the primary keys of the layouts
Returns:: the matching layouts, or an empty list if no matches were found
Throws:: PortalException - if a portal exception occurred

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           String type)
                                                                                    throws PortalException

Returns all the layouts that match the type and belong to the group.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group; type - the type of the layouts (optionally LayoutConstants#TYPE_PORTLET)
Returns:: the matching layouts, or null if no matches were found
Throws:: PortalException

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutReference[] getLayouts(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

getLayoutsByLayoutPrototypeUuid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)

getLayoutsByLayoutPrototypeUuidCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)

getLayoutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayoutsByUuidAndCompanyId(String uuid,
                                                                                                             long companyId)

Returns all the layouts matching the UUID and company.

Parameters:: uuid - the UUID of the layouts; companyId - the primary key of the company
Returns:: the matching layouts, or an empty list if no matches were found

getLayoutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayoutsByUuidAndCompanyId(String uuid,
                                                                                                             long companyId,
                                                                                                             int start,
                                                                                                             int end,
                                                                                                             OrderByComparator<Layout> orderByComparator)

Returns a range of layouts matching the UUID and company.

Parameters:: uuid - the UUID of the layouts; companyId - the primary key of the company; start - the lower bound of the range of layouts; end - the upper bound of the range of layouts (not inclusive); orderByComparator - the comparator to order the results by (optionally null)
Returns:: the range of matching layouts, or an empty list if no matches were found

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount()

Returns the number of layouts.

Returns:: the number of layouts

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(Group group,
                                                                                       boolean privateLayout)
                                                                                throws PortalException

Throws:: PortalException

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(Group group,
                                                                                       boolean privateLayout,
                                                                                       boolean includeUserGroups)
                                                                                throws PortalException

Throws:: PortalException

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(Group group,
                                                                                       boolean privateLayout,
                                                                                       long parentLayoutId)

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(Group group,
                                                                                       boolean privateLayout,
                                                                                       long[] layoutIds)

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(User user,
                                                                                       boolean privateLayout)
                                                                                throws PortalException

Throws:: PortalException

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(User user,
                                                                                       boolean privateLayout,
                                                                                       boolean includeUserGroups)
                                                                                throws PortalException

Throws:: PortalException

getNextLayoutId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getNextLayoutId(long groupId,
                                                                                        boolean privateLayout)

Returns the primary key to use for the next layout.

Parameters:: groupId - the primary key of the group; privateLayout - whether the layout is private to the group
Returns:: the primary key to use for the next layout

getNoPermissionLayouts
```
@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getNoPermissionLayouts(long roleId)
```
Deprecated. As of Judson (7.1.x), with no direct replacement

Returns all the layouts without resource permissions

Parameters:

roleId - the primary key of the role

Returns:

all the layouts without resource permissions

getNullFriendlyURLLayouts
```
@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getNullFriendlyURLLayouts()
```
Deprecated. As of Judson (7.1.x), with no direct replacement

Returns all the layouts whose friendly URLs are null

Returns:

all the layouts whose friendly URLs are null

getOSGiServiceIdentifier
```
String getOSGiServiceIdentifier()
```
Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getParentLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getParentLayout(Layout layout)
                                                                                   throws PortalException

Throws:: PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:: getPersistedModel in interface PersistedModelLocalService
Throws:: PortalException

getScopeGroupLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getScopeGroupLayouts(long parentGroupId)
                                                                                              throws PortalException

Throws:: PortalException

getScopeGroupLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getScopeGroupLayouts(long parentGroupId,
                                                                                                     boolean privateLayout)
                                                                                              throws PortalException

Returns all the layouts within scope of the group.

Parameters:: parentGroupId - the primary key of the group's parent group; privateLayout - whether the layout is private to the group
Returns:: the layouts within scope of the group
Throws:: PortalException - if a portal exception occurred

hasLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayout(String uuid,
                                                                                     long groupId,
                                                                                     boolean privateLayout)
                                                                              throws PortalException

Returns true if there is a matching layout with 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:: true if the layout is found; false otherwise
Throws:: PortalException - if a portal exception occurred

hasLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayouts(Group group)
                                                                               throws PortalException

Throws:: PortalException

hasLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayouts(Group group,
                                                                                      boolean privateLayout)
                                                                               throws PortalException

Throws:: PortalException

hasLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayouts(Group group,
                                                                                      boolean privateLayout,
                                                                                      boolean includeUserGroups)
                                                                               throws PortalException

Throws:: PortalException

hasLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayouts(long groupId,
                                                                                      boolean privateLayout,
                                                                                      long parentLayoutId)

Returns true if the group has any layouts; false otherwise.

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
Returns:: true if the group has any layouts; false otherwise

hasLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayouts(User user,
                                                                                      boolean privateLayout)
                                                                               throws PortalException

Throws:: PortalException

hasLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayouts(User user,
                                                                                      boolean privateLayout,
                                                                                      boolean includeUserGroups)
                                                                               throws PortalException

Throws:: PortalException

hasLayoutSetPrototypeLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId,
                                                                                                       String layoutUuid)
                                                                                                throws PortalException

Throws:: PortalException

hasLayoutSetPrototypeLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid,
                                                                                                       long companyId,
                                                                                                       String layoutUuid)
                                                                                                throws PortalException

Throws:: PortalException

importLayouts

@Deprecated
void importLayouts(ExportImportConfiguration exportImportConfiguration,
                               File file)
                        throws PortalException

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

ExportImportLocalService.importLayouts(
	ExportImportConfiguration, File)

}

Throws:: PortalException

importLayouts

@Deprecated
void importLayouts(ExportImportConfiguration exportImportConfiguration,
                               InputStream is)
                        throws PortalException

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

ExportImportLocalService.importLayouts(
	ExportImportConfiguration, InputStream)

}

Throws:: PortalException

importLayouts
```
@Deprecated
void importLayouts(long userId,
                               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.

Parameters:

userId - the primary key of the user

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
void importLayouts(long userId,
                               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.

Parameters:

userId - the primary key of the user

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
void importLayouts(long userId,
                               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.

Parameters:

userId - the primary key of the user

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

importLayoutsDataDeletions

@Deprecated
void importLayoutsDataDeletions(ExportImportConfiguration exportImportConfiguration,
                                            File file)
                                     throws PortalException

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

ExportImportLocalService.importLayoutsDataDeletions(
	ExportImportConfiguration, File)

Throws:: PortalException

importLayoutsInBackground

@Deprecated
long importLayoutsInBackground(long userId,
                                           ExportImportConfiguration exportImportConfiguration,
                                           File file)
                                    throws PortalException

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

ExportImportLocalService.importLayoutsInBackground(
	long, ExportImportConfiguration, File)

Throws:: PortalException

importLayoutsInBackground

@Deprecated
long importLayoutsInBackground(long userId,
                                           long exportImportConfigurationId,
                                           File file)
                                    throws PortalException

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

ExportImportLocalService.importLayoutsInBackground(
	long, long, File)

Throws:: PortalException

importLayoutsInBackground

@Deprecated
long importLayoutsInBackground(long userId,
                                           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

Throws:: PortalException

importLayoutsInBackground

@Deprecated
long importLayoutsInBackground(long userId,
                                           String taskName,
                                           long groupId,
                                           boolean privateLayout,
                                           Map<String,String[]> parameterMap,
                                           InputStream is)
                                    throws PortalException

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

Throws:: PortalException

importPortletDataDeletions

@Deprecated
void importPortletDataDeletions(ExportImportConfiguration exportImportConfiguration,
                                            File file)
                                     throws PortalException

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

ExportImportLocalService.importPortletDataDeletions(
	ExportImportConfiguration, File)

Throws:: PortalException

importPortletInfo

@Deprecated
void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                   File file)
                            throws PortalException

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

ExportImportLocalService.importPortletInfo(
	ExportImportConfiguration, File)

Throws:: PortalException

importPortletInfo

@Deprecated
void importPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                   InputStream is)
                            throws PortalException

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

ExportImportLocalService.importPortletInfo(
	ExportImportConfiguration, InputStream)

Throws:: PortalException

importPortletInfo
```
@Deprecated
void importPortletInfo(long userId,
                                   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.

Parameters:

userId - the primary key of the user

plid - the primary key of the target layout

groupId - the primary key of the target 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
void importPortletInfo(long userId,
                                   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.

Parameters:

userId - the primary key of the user

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
void importPortletInfo(long userId,
                                   String portletId,
                                   Map<String,String[]> parameterMap,
                                   File file)
                            throws PortalException

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

Throws:: PortalException

importPortletInfo

@Deprecated
void importPortletInfo(long userId,
                                   String portletId,
                                   Map<String,String[]> parameterMap,
                                   InputStream is)
                            throws PortalException

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

Throws:: PortalException

importPortletInfoInBackground

@Deprecated
long importPortletInfoInBackground(long userId,
                                               ExportImportConfiguration exportImportConfiguration,
                                               File file)
                                        throws PortalException

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

ExportImportLocalService.importPortletInfoInBackground(
	long, ExportImportConfiguration, File)

Throws:: PortalException

importPortletInfoInBackground

@Deprecated
long importPortletInfoInBackground(long userId,
                                               long exportImportConfigurationId,
                                               File file)
                                        throws PortalException

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

ExportImportLocalService.importPortletInfoInBackground(
	long, long, File)

Throws:: PortalException

importPortletInfoInBackground

@Deprecated
long importPortletInfoInBackground(long userId,
                                               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

Throws:: PortalException

importPortletInfoInBackground

@Deprecated
long importPortletInfoInBackground(long userId,
                                               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

Throws:: PortalException

importPortletInfoInBackground

@Deprecated
long importPortletInfoInBackground(long userId,
                                               String taskName,
                                               String portletId,
                                               Map<String,String[]> parameterMap,
                                               File file)
                                        throws PortalException

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

Throws:: PortalException

importPortletInfoInBackground

@Deprecated
long importPortletInfoInBackground(long userId,
                                               String taskName,
                                               String portletId,
                                               Map<String,String[]> parameterMap,
                                               InputStream is)
                                        throws PortalException

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

Throws:: PortalException

setLayouts
```
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.

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 - if a portal exception occurred

updateAsset

void updateAsset(long userId,
                 Layout layout,
                 long[] assetCategoryIds,
                 String[] assetTagNames)
          throws PortalException

Throws:: PortalException

updateFriendlyURL
```
Layout updateFriendlyURL(long userId,
                         long plid,
                         String friendlyURL,
                         String languageId)
                  throws PortalException
```
Updates the friendly URL of the layout.

Parameters:

userId - the primary key of the user

plid - the primary key of the layout

friendlyURL - the friendly URL to be assigned

languageId - the primary key of the language

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateFriendlyURL
```
@Deprecated
Layout updateFriendlyURL(long plid,
                                     String friendlyURL,
                                     String languageId)
                              throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by updateFriendlyURL(long, long, String, String)

Updates the friendly URL of the layout.

Parameters:

plid - the primary key of the layout

friendlyURL - the friendly URL to be assigned

languageId - the primary key of the language

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateIconImage

Layout updateIconImage(long plid,
                       byte[] bytes)
                throws PortalException

Throws:: PortalException

updateLayout
```
@Indexable(type=REINDEX)
Layout updateLayout(Layout layout)
```
Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

layout - the layout

Returns:

the layout that was updated

updateLayout
```
Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    long parentLayoutId,
                    Map<Locale,String> nameMap,
                    Map<Locale,String> titleMap,
                    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.

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

nameMap - the locales and localized names to merge (optionally null)

titleMap - the locales and localized titles to merge (optionally null)

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. For layouts that are linked to a layout prototype, attributes named layoutPrototypeUuid and layoutPrototypeLinkedEnabled can be specified to provide the unique identifier of the source prototype and a boolean to determine whether a link to it should be enabled to activate propagation of changes made to the linked page in the prototype.

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateLayout
```
Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    String typeSettings)
             throws 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:

PortalException - if a portal exception occurred

updateLookAndFeel
```
Layout updateLookAndFeel(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         String themeId,
                         String colorSchemeId,
                         String css)
                  throws 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:

PortalException - if a portal exception occurred

updateName
```
Layout updateName(Layout layout,
                  String name,
                  String languageId)
           throws PortalException
```
Updates the name of the layout.

Parameters:

layout - the layout to be updated

name - the layout's new name

languageId - the primary key of the language. For more information see Locale.

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateName
```
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.

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 - if a portal exception occurred

updateName
```
Layout updateName(long plid,
                  String name,
                  String languageId)
           throws 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:

PortalException - if a portal exception occurred

updateParentLayoutId
```
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.

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 - if a portal exception occurred

updateParentLayoutId
```
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.

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 - if a portal exception occurred

updateParentLayoutIdAndPriority
```
Layout updateParentLayoutIdAndPriority(long plid,
                                       long parentPlid,
                                       int priority)
                                throws 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:

PortalException - if a portal exception occurred

updatePriorities
```
void updatePriorities(long groupId,
                      boolean privateLayout)
               throws PortalException
```
Updates the priorities of the layouts.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

Throws:

PortalException

updatePriority
```
Layout updatePriority(Layout layout,
                      int priority)
               throws PortalException
```
Updates the priority of the layout.

Parameters:

layout - the layout to be updated

priority - the layout's new priority

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updatePriority
```
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.

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 - if a portal exception occurred

updatePriority
```
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.

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 - if a portal exception occurred

updatePriority
```
Layout updatePriority(long plid,
                      int priority)
               throws 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:

PortalException - if a portal exception occurred

validateImportLayoutsFile

@Deprecated
MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
                                                        File file)
                                                 throws PortalException

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

ExportImportLocalService.validateImportLayoutsFile(
	ExportImportConfiguration, File)

Throws:: PortalException

validateImportLayoutsFile

@Deprecated
MissingReferences validateImportLayoutsFile(ExportImportConfiguration exportImportConfiguration,
                                                        InputStream inputStream)
                                                 throws PortalException

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

ExportImportLocalService.validateImportLayoutsFile(
	ExportImportConfiguration, InputStream)

Throws:: PortalException

validateImportLayoutsFile

@Deprecated
MissingReferences validateImportLayoutsFile(long userId,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        Map<String,String[]> parameterMap,
                                                        File file)
                                                 throws PortalException

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

Throws:: PortalException

validateImportLayoutsFile

@Deprecated
MissingReferences validateImportLayoutsFile(long userId,
                                                        long groupId,
                                                        boolean privateLayout,
                                                        Map<String,String[]> parameterMap,
                                                        InputStream inputStream)
                                                 throws PortalException

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

Throws:: PortalException

validateImportPortletInfo

@Deprecated
MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                                        File file)
                                                 throws PortalException

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

ExportImportLocalService.validateImportPortletInfo(
	ExportImportConfiguration, File)

Throws:: PortalException

validateImportPortletInfo

@Deprecated
MissingReferences validateImportPortletInfo(ExportImportConfiguration exportImportConfiguration,
                                                        InputStream inputStream)
                                                 throws PortalException

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

ExportImportLocalService.validateImportPortletInfo(
	ExportImportConfiguration, InputStream)

Throws:: PortalException

validateImportPortletInfo

@Deprecated
MissingReferences validateImportPortletInfo(long userId,
                                                        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

Throws:: PortalException

validateImportPortletInfo

@Deprecated
MissingReferences validateImportPortletInfo(long userId,
                                                        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

Throws:: PortalException

Interface LayoutLocalService

Method Summary

Method Detail

addLayout

addLayout

addLayout

createLayout

deleteLayout

deleteLayout

deleteLayout

deleteLayout

deleteLayout

deleteLayouts

deletePersistedModel

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

exportLayouts

exportLayouts

exportLayoutsAsFile

exportLayoutsAsFile

exportLayoutsAsFileInBackground

exportLayoutsAsFileInBackground

exportLayoutsAsFileInBackground

exportLayoutsAsFileInBackground

exportPortletInfo

exportPortletInfo

exportPortletInfoAsFile

exportPortletInfoAsFile

exportPortletInfoAsFile

exportPortletInfoAsFileInBackground

exportPortletInfoAsFileInBackground

exportPortletInfoAsFileInBackground

exportPortletInfoAsFileInBackground

fetchDefaultLayout

fetchFirstLayout

fetchLayout

fetchLayout

fetchLayout

fetchLayoutByFriendlyURL

fetchLayoutByIconImageId

fetchLayoutByUuidAndGroupId

getActionableDynamicQuery

getDefaultPlid

getDefaultPlid

getDefaultPlid

getExportActionableDynamicQuery

getFriendlyURLLayout

getIndexableActionableDynamicQuery

getLayout

getLayout

getLayoutByIconImageId

getLayoutByUuidAndGroupId

getLayoutChildLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayoutsByLayoutPrototypeUuid

getLayoutsByLayoutPrototypeUuidCount

getLayoutsByUuidAndCompanyId

getLayoutsByUuidAndCompanyId

getLayoutsCount

getLayoutsCount

getLayoutsCount

getLayoutsCount

getLayoutsCount

getLayoutsCount

getLayoutsCount

getNextLayoutId

getNoPermissionLayouts