LayoutLocalService (Liferay 7.2.1-ga2 portal-kernel API)

All Superinterfaces:

BaseLocalService, PersistedModelLocalService, VersionService<Layout,LayoutVersion>

All Known Implementing Classes:

LayoutLocalServiceWrapper
```
@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LayoutLocalService
extends BaseLocalService, PersistedModelLocalService, VersionService<Layout,LayoutVersion>
```
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

{$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, long classNameId, long classPK, 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, boolean system, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)` Adds a layout with additional parameters.
`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, boolean system, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext)` Adds a layout with additional parameters.
`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, boolean system, String friendlyURL, ServiceContext serviceContext)` Adds a layout with single entry maps for name, title, and description to the default locale.
`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.
`void`	`anonymizeLayout(Layout layout, long userId, User anonymousUser)` Anonymize user information of the specific layout
`Layout`	`checkout(Layout publishedLayout, int version)` Checks out the previous version of the versioned model and saves it as a draft.
`Layout`	`create()` Creates a new layout.
`Layout`	`delete(Layout publishedLayout)` Deletes the `VersionedModel`.
`Layout`	`deleteDraft(Layout draftLayout)` Deletes the `VersionedModel` if it is a draft.
`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 layout ID, 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)`
`LayoutVersion`	`deleteVersion(LayoutVersion layoutVersion)` Deletes the `VersionModel` if it is not the latest version.
`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.
`Layout`	`fetchDefaultLayout(long groupId, boolean privateLayout)`
`Layout`	`fetchDraft(Layout layout)` Fetches the draft if it exists; otherwise, returns `null`.
`Layout`	`fetchDraft(long primaryKey)` Fetches the draft if it exists; otherwise, returns `null`.
`Layout`	`fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId)`
`Layout`	`fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId, boolean hidden)`
`LayoutVersion`	`fetchLatestVersion(Layout layout)` Fetches the latest version model if it exists.
`Layout`	`fetchLayout(long plid)`
`Layout`	`fetchLayout(long groupId, boolean privateLayout, long layoutId)`
`Layout`	`fetchLayout(long classNameId, long classPK)`
`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.
`LayoutVersion`	`fetchLayoutVersion(long layoutVersionId)`
`Layout`	`fetchPublished(Layout layout)` Fetches the published versioned model if it exists.
`Layout`	`fetchPublished(long primaryKey)` Fetches the published versioned model if it exists; otherwise, returns `null`.
`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
`Layout`	`getDraft(Layout layout)` Returns the versioned model draft.
`Layout`	`getDraft(long primaryKey)` Returns the versioned model draft with the primary key.
`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 layout ID, 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)` Deprecated. As of Judson (7.1.x), replaced by `getLayoutChildLayouts(List)`
`Map<Long,List<Layout>>`	`getLayoutChildLayouts(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.
`List<Layout>`	`getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> obc)` Returns a range of all the layouts belonging to the group.
`List<Layout>`	`getLayouts(long groupId, int start, int end, OrderByComparator<Layout> obc)` Returns a range of all the layouts belonging to the group.
`List<Layout>`	`getLayouts(long groupId, String keywords, String[] types, int start, int end, OrderByComparator<Layout> obc)` Returns a range of all the layouts belonging 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(Group group, boolean privateLayout, String keywords, String[] types)`
`int`	`getLayoutsCount(long groupId)`
`int`	`getLayoutsCount(long groupId, String keywords, String[] types)`
`int`	`getLayoutsCount(User user, boolean privateLayout)`
`int`	`getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups)`
`long`	`getNextLayoutId(long groupId, boolean privateLayout)` Returns the layout ID 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.
`LayoutVersion`	`getVersion(Layout layout, int version)` Returns the `VersionModel` for the `VersionedModel` matching the version.
`List<LayoutVersion>`	`getVersions(Layout layout)` Returns the `VersionModel`s for the `VersionedModel`.
`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)`
`Layout`	`publishDraft(Layout draftLayout)` Publishes the draft and creates a new version model for the new version.
`void`	`registerListener(VersionServiceListener<Layout,LayoutVersion> versionServiceListener)` Registers the `VersionServiceListener`.
`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`	`unregisterListener(VersionServiceListener<Layout,LayoutVersion> versionServiceListener)` Unregisters the `VersionServiceListener`.
`void`	`updateAsset(long userId, Layout layout, long[] assetCategoryIds, String[] assetTagNames)`
`Layout`	`updateDraft(Layout draftLayout)` Updates the draft.
`Layout`	`updateFriendlyURL(long userId, long plid, String friendlyURL, String languageId)` Updates the friendly URL of the layout.
`Layout`	`updateIconImage(long plid, byte[] bytes)`
`Layout`	`updateLayout(Layout draftLayout)` Updates the layout in the database or adds it if it does not yet exist.
`Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, Date publishDate)` Updates the layout replacing its draft publish date.
`Layout`	`updateLayout(long groupId, boolean privateLayout, long layoutId, long classNameId, long classPK)` Updates the layout replacing its entity class name ID and primary key.
`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 hasIconImage, 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.
`Layout`	`updateType(long plid, String type)`

- 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
```
@Indexable(type=REINDEX)
Layout addLayout(long userId,
                                          long groupId,
                                          boolean privateLayout,
                                          long parentLayoutId,
                                          long classNameId,
                                          long classPK,
                                          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,
                                          boolean system,
                                          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 layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)
    
    classNameId - the class name ID of the entity
    
    classPK - the primary key of the entity
    
    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
    
    system - whether the layout is of system type
    
    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
```
@Indexable(type=REINDEX)
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,
                                          boolean system,
                                          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 layout ID 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
    
    system - whether the layout is of system type
    
    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
```
@Indexable(type=REINDEX)
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 layout ID 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,
                 boolean system,
                 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 layout ID 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
    
    system - whether the layout is of system type
    
    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
  - 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 layout ID 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
  - anonymizeLayout
```
void anonymizeLayout(Layout layout,
                     long userId,
                     User anonymousUser)
              throws PortalException
```
    Anonymize user information of the specific layout
    
    Parameters:
    
    layout - the layout that need to anonymized
    
    userId - the primary key of the owner user
    
    anonymousUser - the anonymized user information
    
    Throws:
    
    PortalException
  - checkout
```
@Indexable(type=REINDEX)
Layout checkout(Layout publishedLayout,
                                         int version)
                                  throws PortalException
```
    Description copied from interface: VersionService
    
    Checks out the previous version of the versioned model and saves it as a draft. Any VersionServiceListener that has been registered is also notified. An IllegalArgumentException is thrown if the versioned model already has a draft.
    
    Specified by:
    
    checkout in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    publishedLayout - the published versioned model
    
    version - the version
    
    Returns:
    
    the draft VersionModel being checked out
    
    Throws:
    
    PortalException - if the version does not exist
  - create
```
@Transactional(enabled=false)
Layout create()
```
    Creates a new layout. Does not add the layout to the database.
    
    Specified by:
    
    create in interface VersionService<Layout,LayoutVersion>
    
    Returns:
    
    the new layout
  - delete
```
@Indexable(type=DELETE)
Layout delete(Layout publishedLayout)
                               throws PortalException
```
    Description copied from interface: VersionService
    
    Deletes the VersionedModel. Related drafts and versions are also deleted. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is a draft. Drafts can be deleted by calling VersionService.deleteDraft(VersionedModel).
    
    Specified by:
    
    delete in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    publishedLayout - the published versioned model
    
    Returns:
    
    the versioned model that is deleted
    
    Throws:
    
    PortalException - if a portal exception occurred
  - deleteDraft
```
@Indexable(type=DELETE)
Layout deleteDraft(Layout draftLayout)
                                    throws PortalException
```
    Description copied from interface: VersionService
    
    Deletes the VersionedModel if it is a draft. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a draft. Published versioned models can be deleted by calling VersionService.delete(VersionedModel).
    
    Specified by:
    
    deleteDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    draftLayout - the draft versioned model
    
    Returns:
    
    the versioned model that is deleted
    
    Throws:
    
    PortalException - if a portal exception occurred
  - 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 layout ID, 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 layout ID 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
  - deleteVersion
```
LayoutVersion deleteVersion(LayoutVersion layoutVersion)
                     throws PortalException
```
    Description copied from interface: VersionService
    
    Deletes the VersionModel if it is not the latest version. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is the latest version.
    
    Specified by:
    
    deleteVersion in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layoutVersion - the version model
    
    Returns:
    
    the version model that is deleted
    
    Throws:
    
    PortalException - if a portal exception occurred
  - dynamicQuery
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()
```
  - dynamicQuery
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutModelImpl.
    
    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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutModelImpl.
    
    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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
  - fetchDefaultLayout
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchDefaultLayout(long groupId,
                                                                                             boolean privateLayout)
```
  - fetchDraft
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchDraft(Layout layout)
```
    Description copied from interface: VersionService
    
    Fetches the draft if it exists; otherwise, returns null.
    
    Specified by:
    
    fetchDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layout - the draft or published versioned model
    
    Returns:
    
    the draft versioned model if it exists; otherwise null
  - fetchDraft
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchDraft(long primaryKey)
```
    Description copied from interface: VersionService
    
    Fetches the draft if it exists; otherwise, returns null.
    
    Specified by:
    
    fetchDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    primaryKey - the draft or published versioned model's primary key
    
    Returns:
    
    the draft versioned model if it exists; otherwise null
  - fetchFirstLayout
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchFirstLayout(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long parentLayoutId)
```
  - fetchFirstLayout
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchFirstLayout(long groupId,
                                                                                           boolean privateLayout,
                                                                                           long parentLayoutId,
                                                                                           boolean hidden)
```
  - fetchLatestVersion
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutVersion fetchLatestVersion(Layout layout)
```
    Description copied from interface: VersionService
    
    Fetches the latest version model if it exists. If the versioned model has never been published, null is returned.
    
    Specified by:
    
    fetchLatestVersion in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layout - the versioned model
    
    Returns:
    
    the latest version model if it exists; otherwise null
  - 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(long classNameId,
                                                                                      long classPK)
```
  - 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
  - fetchLayoutVersion
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutVersion fetchLayoutVersion(long layoutVersionId)
```
  - fetchPublished
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchPublished(Layout layout)
```
    Description copied from interface: VersionService
    
    Fetches the published versioned model if it exists. If the versioned model has never been published, null is returned.
    
    Specified by:
    
    fetchPublished in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layout - the versioned model
    
    Returns:
    
    the published versioned model if it exists; otherwise null
  - fetchPublished
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout fetchPublished(long primaryKey)
```
    Description copied from interface: VersionService
    
    Fetches the published versioned model if it exists; otherwise, returns null.
    
    Specified by:
    
    fetchPublished in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    primaryKey - the published versioned model's primary key
    
    Returns:
    
    the published versioned model if it exists; otherwise null
  - 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
  - getDraft
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getDraft(Layout layout)
                                                                            throws PortalException
```
    Description copied from interface: VersionService
    
    Returns the versioned model draft. If the draft does not exist, it is lazily created, adding it to the database. If a draft is lazily created, any VersionServiceListener that has been registered is notified.
    
    Specified by:
    
    getDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layout - the versioned model
    
    Returns:
    
    the versioned model
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getDraft
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getDraft(long primaryKey)
                                                                            throws PortalException
```
    Description copied from interface: VersionService
    
    Returns the versioned model draft with the primary key. If it does not exist, a new draft is lazily created and added to the database. If a draft is lazily created, any VersionServiceListener that has been registered is notified.
    
    Specified by:
    
    getDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    primaryKey - of the draft or published versioned model
    
    Returns:
    
    the versioned model
    
    Throws:
    
    PortalException - if no draft or published versioned model exists with the primary key
  - 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 layout ID, 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 layout ID 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
```
@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,List<Layout>> getLayoutChildLayouts(LayoutSet layoutSet,
                                                                                                                             List<Layout> parentLayouts)
```
    Deprecated. As of Judson (7.1.x), replaced by getLayoutChildLayouts(List)
  - getLayoutChildLayouts
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,List<Layout>> getLayoutChildLayouts(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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutModelImpl.
    
    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 layout ID 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 layout ID 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 layout ID 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 layout IDs 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)
List<Layout> getLayouts(long groupId,
                                                                                           boolean privateLayout,
                                                                                           String keywords,
                                                                                           String[] types,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Layout> obc)
                                                                                    throws PortalException
```
    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
    
    keywords - keywords
    
    types - layout types
    
    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
    
    Throws:
    
    PortalException
  - getLayouts
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           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
    
    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)
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
  - getLayouts
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Layout> getLayouts(long groupId,
                                                                                           String keywords,
                                                                                           String[] types,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Layout> obc)
                                                                                    throws PortalException
```
    Returns a range of all the layouts belonging to the group.
    
    Parameters:
    
    groupId - the primary key of the group
    
    keywords - keywords
    
    types - layout types
    
    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
    
    Throws:
    
    PortalException
  - 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(Group group,
                                                                                       boolean privateLayout,
                                                                                       String keywords,
                                                                                       String[] types)
                                                                                throws PortalException
```
    Throws:
    
    PortalException
  - getLayoutsCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(long groupId)
```
  - getLayoutsCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(long groupId,
                                                                                       String keywords,
                                                                                       String[] types)
                                                                                throws PortalException
```
    Throws:
    
    PortalException
  - 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 layout ID 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 layout ID 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
  - getVersion
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutVersion getVersion(Layout layout,
                                                                                            int version)
                                                                                     throws PortalException
```
    Description copied from interface: VersionService
    
    Returns the VersionModel for the VersionedModel matching the version.
    
    Specified by:
    
    getVersion in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layout - the versioned model
    
    version - the version
    
    Returns:
    
    the version model
    
    Throws:
    
    PortalException - if the version does not exist
  - getVersions
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutVersion> getVersions(Layout layout)
```
    Description copied from interface: VersionService
    
    Returns the VersionModels for the VersionedModel. They are sorted in descending order.
    
    Specified by:
    
    getVersions in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    layout - the versioned model
    
    Returns:
    
    the version models
  - 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 layout ID 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
  - publishDraft
```
@Indexable(type=REINDEX)
Layout publishDraft(Layout draftLayout)
                                      throws PortalException
```
    Description copied from interface: VersionService
    
    Publishes the draft and creates a new version model for the new version. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a draft.
    
    Specified by:
    
    publishDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    draftLayout - the draft version model
    
    Returns:
    
    the published versioned model
    
    Throws:
    
    PortalException - if a portal exception occurred
  - registerListener
```
void registerListener(VersionServiceListener<Layout,LayoutVersion> versionServiceListener)
```
    Description copied from interface: VersionService
    
    Registers the VersionServiceListener.
    
    Specified by:
    
    registerListener in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    versionServiceListener - the version service listener to register
  - 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 layout ID of the parent layout
    
    layoutIds - the layout IDs of the layouts
    
    serviceContext - the service context to be applied
    
    Throws:
    
    PortalException - if a portal exception occurred
  - unregisterListener
```
void unregisterListener(VersionServiceListener<Layout,LayoutVersion> versionServiceListener)
```
    Description copied from interface: VersionService
    
    Unregisters the VersionServiceListener.
    
    Specified by:
    
    unregisterListener in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    versionServiceListener - the version service listener to unregister
  - updateAsset
```
void updateAsset(long userId,
                 Layout layout,
                 long[] assetCategoryIds,
                 String[] assetTagNames)
          throws PortalException
```
    Throws:
    
    PortalException
  - updateDraft
```
@Indexable(type=REINDEX)
Layout updateDraft(Layout draftLayout)
                                     throws PortalException
```
    Description copied from interface: VersionService
    
    Updates the draft. Any VersionServiceListener that has been registered is notified. An IllegalArgumentException is thrown if the versioned model is not a draft.
    
    Specified by:
    
    updateDraft in interface VersionService<Layout,LayoutVersion>
    
    Parameters:
    
    draftLayout - the draft version model
    
    Returns:
    
    the draft versioned model
    
    Throws:
    
    PortalException - if a portal exception occurred
  - 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
  - updateIconImage
```
Layout updateIconImage(long plid,
                       byte[] bytes)
                throws PortalException
```
    Throws:
    
    PortalException
  - updateLayout
```
@Indexable(type=REINDEX)
Layout updateLayout(Layout draftLayout)
                                      throws PortalException
```
    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
    
    Throws:
    
    PortalException
  - updateLayout
```
Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    Date publishDate)
             throws PortalException
```
    Updates the layout replacing its draft publish date.
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the layout ID of the layout
    
    publishDate - the date when draft was last published
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException - if a portal exception occurred
  - updateLayout
```
Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    long classNameId,
                    long classPK)
             throws PortalException
```
    Updates the layout replacing its entity class name ID and primary key.
    
    Parameters:
    
    groupId - the primary key of the group
    
    privateLayout - whether the layout is private to the group
    
    layoutId - the layout ID of the layout
    
    classNameId - the class name ID of the entity
    
    classPK - the primary key of the entity
    
    Returns:
    
    the updated layout
    
    Throws:
    
    PortalException - if a portal exception occurred
  - 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 hasIconImage,
                    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 layout ID of the layout
    
    parentLayoutId - the layout ID 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).
    
    hasIconImage - 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 layout ID 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 layout ID 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 layout ID 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 layout ID of the layout
    
    parentLayoutId - the layout ID 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 layout ID 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 layout ID of the layout
    
    nextLayoutId - the layout ID of the next layout
    
    previousLayoutId - the layout ID 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
  - updateType
```
Layout updateType(long plid,
                  String type)
           throws PortalException
```
    Throws:
    
    PortalException

Interface LayoutLocalService

Method Summary

Method Detail

addLayout

addLayout

addLayout

addLayout

addLayout

addLayout

anonymizeLayout

checkout

create

delete

deleteDraft

deleteLayout

deleteLayout

deleteLayout

deleteLayout

deleteLayout

deleteLayouts

deletePersistedModel

deleteVersion

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchDefaultLayout

fetchDraft

fetchDraft

fetchFirstLayout

fetchFirstLayout

fetchLatestVersion

fetchLayout

fetchLayout

fetchLayout

fetchLayout

fetchLayoutByFriendlyURL

fetchLayoutByIconImageId

fetchLayoutByUuidAndGroupId

fetchLayoutVersion

fetchPublished

fetchPublished

getActionableDynamicQuery

getDefaultPlid

getDefaultPlid

getDefaultPlid

getDraft

getDraft

getExportActionableDynamicQuery

getFriendlyURLLayout

getIndexableActionableDynamicQuery

getLayout

getLayout

getLayoutByIconImageId

getLayoutByUuidAndGroupId

getLayoutChildLayouts

getLayoutChildLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayouts

getLayoutsByLayoutPrototypeUuid

getLayoutsByLayoutPrototypeUuidCount

getLayoutsByUuidAndCompanyId

getLayoutsByUuidAndCompanyId

getLayoutsCount

getLayoutsCount

getLayoutsCount

getLayoutsCount