Class LayoutLocalServiceUtil
com.liferay.portal.service.impl.LayoutLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Layout
Adds the layout to the database.static Layout
addLayout
(String externalReferenceCode, 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, long masterLayoutPlid, ServiceContext serviceContext) Adds a layout with additional parameters.static Layout
addLayout
(String externalReferenceCode, 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.static Layout
addLayout
(String externalReferenceCode, 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.static Layout
addLayout
(String externalReferenceCode, 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.static Layout
addLayout
(String externalReferenceCode, 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.static Layout
copyLayout
(long userId, long groupId, boolean privateLayout, Map<Locale, String> nameMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) static Layout
copyLayoutContent
(long[] segmentsExperienceIds, Layout sourceLayout, Layout targetLayout) static Layout
copyLayoutContent
(long segmentsExperienceId, Layout sourceLayout, Layout targetLayout) static Layout
copyLayoutContent
(Layout sourceLayout, Layout targetLayout) static Layout
createLayout
(long plid) Creates a new layout with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static Layout
deleteLayout
(long plid) Deletes the layout with the primary key from the database.static 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.static void
deleteLayout
(long plid, ServiceContext serviceContext) Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.static Layout
deleteLayout
(Layout layout) Deletes the layout from the database.static void
deleteLayout
(Layout layout, ServiceContext serviceContext) Deletes the layout, its child layouts, and its associated resources.static void
deleteLayout
(String externalReferenceCode, long groupId) static 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.static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static Layout
fetchDefaultLayout
(long groupId, boolean privateLayout) static Layout
fetchDraftLayout
(long plid) static Layout
fetchFirstLayout
(long groupId, boolean privateLayout, long parentLayoutId) static Layout
fetchFirstLayout
(long groupId, boolean privateLayout, long parentLayoutId, boolean hidden) static Layout
fetchLayout
(long plid) static Layout
fetchLayout
(long groupId, boolean privateLayout, long layoutId) static Layout
fetchLayout
(long classNameId, long classPK) static Layout
fetchLayout
(String uuid, long groupId, boolean privateLayout) static Layout
fetchLayoutByExternalReferenceCode
(String externalReferenceCode, long groupId) static Layout
fetchLayoutByFriendlyURL
(long groupId, boolean privateLayout, String friendlyURL) static Layout
fetchLayoutByIconImageId
(boolean privateLayout, long iconImageId) static Layout
fetchLayoutByUuidAndGroupId
(String uuid, long groupId, boolean privateLayout) Returns the layout matching the UUID, group, and privacy.static ActionableDynamicQuery
getAllLayouts
(long groupId, boolean privateLayout, String type) Returns all the layouts that match the type and belong to the group, including the ones marked as System.static Layout
getBrowsableLayout
(Layout layout) static long
getDefaultPlid
(long groupId) Returns the primary key of the default layout for the group.static long
getDefaultPlid
(long groupId, boolean privateLayout) Returns primary key of the matching default layout for the groupstatic long
getDefaultPlid
(long groupId, boolean privateLayout, String portletId) Returns primary key of the default portlet layout for the groupstatic ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static Layout
getFriendlyURLLayout
(long groupId, boolean privateLayout, String friendlyURL) Returns the layout for the friendly URL.static Layout
getLayout
(long plid) Returns the layout with the primary key.static Layout
getLayout
(long groupId, boolean privateLayout, long layoutId) Returns the layout matching the layout ID, group, and privacy; throws aNoSuchLayoutException
otherwise.static Layout
getLayoutByExternalReferenceCode
(String externalReferenceCode, long groupId) static Layout
getLayoutByFriendlyURL
(long groupId, boolean privateLayout, String friendlyURL) static Layout
getLayoutByIconImageId
(long iconImageId) Returns the layout for the icon image; throws aNoSuchLayoutException
otherwise.static Layout
getLayoutByUuidAndGroupId
(String uuid, long groupId, boolean privateLayout) Returns the layout matching the UUID, group, and privacy.getLayoutChildLayouts
(List<Layout> parentLayouts) getLayouts
(int start, int end) Returns a range of all the layouts.getLayouts
(long companyId) getLayouts
(long groupId, boolean privateLayout) Returns all the layouts belonging to the group.getLayouts
(long groupId, boolean privateLayout, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.getLayouts
(long groupId, boolean privateLayout, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.getLayouts
(long groupId, boolean privateLayout, long parentLayoutId) Returns all the layouts belonging to the group that are children of the parent layout.getLayouts
(long groupId, boolean privateLayout, long[] layoutIds) Returns all the layouts that match the layout IDs and belong to the group.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.getLayouts
(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group that are children of the parent layout.getLayouts
(long groupId, boolean privateLayout, String type) Returns all the layouts that match the type and belong to the group.getLayouts
(long groupId, boolean privateLayout, String[] types) Returns all the layouts that match the type and belong to the group.getLayouts
(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.getLayouts
(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.getLayouts
(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) getLayouts
(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.getLayouts
(long groupId, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.getLayouts
(long groupId, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.static 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.getLayouts
(Collection<Serializable> primaryKeys) getLayoutsByLayoutPrototypeUuid
(String layoutPrototypeUuid) static int
getLayoutsByLayoutPrototypeUuidCount
(String layoutPrototypeUuid) getLayoutsByUuidAndCompanyId
(String uuid, long companyId) Returns all the layouts matching the UUID and company.getLayoutsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of layouts matching the UUID and company.static int
Returns the number of layouts.static int
getLayoutsCount
(long groupId) static int
getLayoutsCount
(long groupId, boolean privateLayout) static int
getLayoutsCount
(long groupId, boolean privateLayout, long parentLayoutId) static int
getLayoutsCount
(long groupId, long userId, boolean privateLayout, String keywords, String[] types) static int
getLayoutsCount
(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses) static int
getLayoutsCount
(long groupId, String keywords, String[] types) static int
getLayoutsCount
(long groupId, String keywords, String[] types, int[] statuses) static int
getLayoutsCount
(Group group, boolean privateLayout) static int
getLayoutsCount
(Group group, boolean privateLayout, boolean includeUserGroups) static int
getLayoutsCount
(Group group, boolean privateLayout, long parentLayoutId) static int
getLayoutsCount
(Group group, boolean privateLayout, long[] layoutIds) static int
getLayoutsCount
(Group group, boolean privateLayout, String keywords, String[] types) static int
getLayoutsCount
(User user, boolean privateLayout) static int
getLayoutsCount
(User user, boolean privateLayout, boolean includeUserGroups) getMasterLayouts
(long groupId, long masterLayoutPlid) static int
getMasterLayoutsCount
(long groupId, long masterLayoutPlid) static long
getNextLayoutId
(long groupId, boolean privateLayout) Returns the layout ID to use for the next layout.static String
Returns the OSGi service identifier.static Layout
getParentLayout
(Layout layout) static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getPublishedLayouts
(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator) static int
getPublishedLayoutsCount
(long groupId) getScopeGroupLayouts
(long parentGroupId) getScopeGroupLayouts
(long parentGroupId, boolean privateLayout) Returns all the layouts within scope of the group.static LayoutLocalService
static boolean
Returnstrue
if there is a matching layout with the UUID, group, and privacy.static boolean
hasLayouts
(long groupId, boolean privateLayout, long parentLayoutId) Returnstrue
if the group has any layouts;false
otherwise.static boolean
hasLayouts
(Group group) static boolean
hasLayouts
(Group group, boolean privateLayout) static boolean
hasLayouts
(Group group, boolean privateLayout, boolean includeUserGroups) static boolean
hasLayouts
(User user, boolean privateLayout) static boolean
hasLayouts
(User user, boolean privateLayout, boolean includeUserGroups) static boolean
hasLayoutSetPrototypeLayout
(long layoutSetPrototypeId, String layoutUuid) static boolean
hasLayoutSetPrototypeLayout
(String layoutSetPrototypeUuid, long companyId, String layoutUuid) search
(long groupId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) search
(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) search
(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) static int
searchCount
(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) static int
searchCount
(Group group, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) static 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.static void
setService
(LayoutLocalService service) static void
updateAsset
(long userId, Layout layout, long[] assetCategoryIds, String[] assetTagNames) static Layout
updateFriendlyURL
(long userId, long plid, String friendlyURL, String languageId) Updates the friendly URL of the layout.static Layout
updateIconImage
(long plid, byte[] bytes) static Layout
updateLayout
(long groupId, boolean privateLayout, long layoutId, long classNameId, long classPK) Updates the layout replacing its entity class name ID and primary key.static 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, long styleBookEntryId, long faviconFileEntryId, long masterLayoutPlid, ServiceContext serviceContext) Updates the layout.static Layout
updateLayout
(long groupId, boolean privateLayout, long layoutId, String typeSettings) Updates the layout replacing its type settings.static Layout
updateLayout
(long groupId, boolean privateLayout, long layoutId, String typeSettings, byte[] iconBytes, String themeId, String colorSchemeId, long styleBookEntryId, String css, long faviconFileEntryId, long masterLayoutPlid) static Layout
updateLayout
(long groupId, boolean privateLayout, long layoutId, Date publishDate) Updates the layout replacing its draft publish date.static Layout
updateLayout
(Layout layout) Updates the layout in the database or adds it if it does not yet exist.static Layout
updateLookAndFeel
(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css) Updates the look and feel of the layout.static Layout
updateMasterLayoutPlid
(long groupId, boolean privateLayout, long layoutId, long masterLayoutPlid) Updates the layout replacing its master layout plid.static 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.static Layout
updateName
(long plid, String name, String languageId) Updates the name of the layout matching the primary key.static Layout
updateName
(Layout layout, String name, String languageId) Updates the name of the layout.static 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.static Layout
updateParentLayoutId
(long plid, long parentPlid) Updates the parent layout ID of the layout matching the primary key.static Layout
updateParentLayoutIdAndPriority
(long plid, long parentPlid, int priority) Updates the parent layout ID and priority of the layout.static void
updatePriorities
(long groupId, boolean privateLayout) Updates the priorities of the layouts.static Layout
updatePriority
(long groupId, boolean privateLayout, long layoutId, int priority) Updates the priority of the layout matching the group, layout ID, and privacy.static 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.static Layout
updatePriority
(long plid, int priority) Updates the priority of the layout matching the primary key.static Layout
updatePriority
(Layout layout, int priority) Updates the priority of the layout.static Layout
updateStatus
(long userId, long plid, int status, ServiceContext serviceContext) static Layout
updateStyleBookEntryId
(long groupId, boolean privateLayout, long layoutId, long styleBookEntryId) Updates the layout replacing its style book entry ID.static Layout
updateType
(long plid, String type)
-
Constructor Details
-
LayoutLocalServiceUtil
public LayoutLocalServiceUtil()
-
-
Method Details
-
addLayout
Adds the layout to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
layout
- the layout- Returns:
- the layout that was added
-
addLayout
public static Layout addLayout(String externalReferenceCode, long userId, long groupId, boolean privateLayout, long parentLayoutId, long classNameId, long classPK, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> 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, long masterLayoutPlid, ServiceContext serviceContext) 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:
externalReferenceCode
- the layout's external reference codeuserId
- the primary key of the usergroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)classNameId
- the class name ID of the entityclassPK
- the primary key of the entitynameMap
- the layout's locales and localized namestitleMap
- the layout's locales and localized titlesdescriptionMap
- the layout's locales and localized descriptionskeywordsMap
- the layout's locales and localized keywordsrobotsMap
- the layout's locales and localized robotstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.typeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.hidden
- whether the layout is hiddensystem
- whether the layout is of system typefriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.normalize(String)
.masterLayoutPlid
- the primary key of the master layoutserviceContext
- 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 namedlayoutUpdateable
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 namedlayoutPrototypeUuid
andlayoutPrototypeLinkedEnabled
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
public static Layout addLayout(String externalReferenceCode, long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> 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.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:
externalReferenceCode
- the layout's external reference codeuserId
- the primary key of the usergroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)nameMap
- the layout's locales and localized namestitleMap
- the layout's locales and localized titlesdescriptionMap
- the layout's locales and localized descriptionskeywordsMap
- the layout's locales and localized keywordsrobotsMap
- the layout's locales and localized robotstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.typeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.hidden
- whether the layout is hiddensystem
- whether the layout is of system typefriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.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 namedlayoutUpdateable
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 namedlayoutPrototypeUuid
andlayoutPrototypeLinkedEnabled
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
public static Layout addLayout(String externalReferenceCode, long userId, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> 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.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:
externalReferenceCode
- the layout's external reference codeuserId
- the primary key of the usergroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)nameMap
- the layout's locales and localized namestitleMap
- the layout's locales and localized titlesdescriptionMap
- the layout's locales and localized descriptionskeywordsMap
- the layout's locales and localized keywordsrobotsMap
- the layout's locales and localized robotstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.typeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.hidden
- whether the layout is hiddenfriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.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 namedlayoutUpdateable
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 namedlayoutPrototypeUuid
andlayoutPrototypeLinkedEnabled
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
public static Layout addLayout(String externalReferenceCode, 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:
externalReferenceCode
- the layout's external reference codeuserId
- the primary key of the usergroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
). The possible values can be found inLayoutConstants
.name
- the layout's name (optionallyPropsValues#DEFAULT_USER_PRIVATE_LAYOUT_NAME
orPropsValues#DEFAULT_USER_PUBLIC_LAYOUT_NAME
). The default values can be overridden inportal-ext.properties
by specifying new values for the corresponding properties defined inPropsValues
title
- the layout's titledescription
- the layout's descriptiontype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.hidden
- whether the layout is hiddensystem
- whether the layout is of system typefriendlyURL
- the friendly URL of the layout (optionallyPropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL
orPropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL
). The default values can be overridden inportal-ext.properties
by specifying new values for the corresponding properties defined inPropsValues
. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.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 namedlayoutUpdateable
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
public static Layout addLayout(String externalReferenceCode, 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:
externalReferenceCode
- the layout's external reference codeuserId
- the primary key of the usergroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
). The possible values can be found inLayoutConstants
.name
- the layout's name (optionallyPropsValues#DEFAULT_USER_PRIVATE_LAYOUT_NAME
orPropsValues#DEFAULT_USER_PUBLIC_LAYOUT_NAME
). The default values can be overridden inportal-ext.properties
by specifying new values for the corresponding properties defined inPropsValues
title
- the layout's titledescription
- the layout's descriptiontype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.hidden
- whether the layout is hiddenfriendlyURL
- the friendly URL of the layout (optionallyPropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL
orPropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL
). The default values can be overridden inportal-ext.properties
by specifying new values for the corresponding properties defined inPropsValues
. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.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 namedlayoutUpdateable
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
-
copyLayout
public static Layout copyLayout(long userId, long groupId, boolean privateLayout, Map<Locale, String> nameMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
copyLayoutContent
- Throws:
Exception
-
copyLayoutContent
public static Layout copyLayoutContent(long segmentsExperienceId, Layout sourceLayout, Layout targetLayout) throws Exception - Throws:
Exception
-
copyLayoutContent
public static Layout copyLayoutContent(long[] segmentsExperienceIds, Layout sourceLayout, Layout targetLayout) throws Exception - Throws:
Exception
-
createLayout
Creates a new layout with the primary key. Does not add the layout to the database.- Parameters:
plid
- the primary key for the new layout- Returns:
- the new layout
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteLayout
Deletes the layout from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
layout
- the layout- Returns:
- the layout that was removed
- Throws:
PortalException
-
deleteLayout
public static void deleteLayout(Layout layout, ServiceContext serviceContext) throws PortalException Deletes the layout, its child layouts, and its associated resources.- Parameters:
layout
- the layoutserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
deleteLayout
Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
deleteLayout
Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.- Parameters:
plid
- the primary key of the layoutserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
deleteLayout
- Throws:
PortalException
-
deleteLayouts
public static 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 groupprivateLayout
- whether the layout is private to the groupserviceContext
- the service context to be applied. The parent layout set's page count will be updated by default, unless an attribute namedupdatePageCount
is set tofalse
.- Throws:
PortalException
- if a portal exception occurred
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDefaultLayout
-
fetchDraftLayout
-
fetchFirstLayout
-
fetchFirstLayout
public static Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId, boolean hidden) -
fetchLayout
-
fetchLayout
-
fetchLayout
-
fetchLayout
-
fetchLayoutByExternalReferenceCode
-
fetchLayoutByFriendlyURL
-
fetchLayoutByIconImageId
public static Layout fetchLayoutByIconImageId(boolean privateLayout, long iconImageId) throws PortalException - Throws:
PortalException
-
fetchLayoutByUuidAndGroupId
Returns the layout matching the UUID, group, and privacy.- Parameters:
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the matching layout, or
null
if a matching layout could not be found
-
getActionableDynamicQuery
-
getAllLayouts
public static List<Layout> getAllLayouts(long groupId, boolean privateLayout, String type) throws PortalException Returns all the layouts that match the type and belong to the group, including the ones marked as System.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptype
- the type of the layouts (optiona.llyLayoutConstants#TYPE_PORTLET
)- Returns:
- the matching layouts, or an empty list if no matches were found
- Throws:
PortalException
-
getBrowsableLayout
-
getDefaultPlid
public static 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
public static long getDefaultPlid(long groupId, boolean privateLayout) Returns primary key of the matching default layout for the group- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the primary key of the default layout for the group;
LayoutConstants#DEFAULT_PLID
) otherwise
-
getDefaultPlid
public static 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 groupprivateLayout
- whether the layout is private to the groupportletId
- the primary key of the portlet- Returns:
- the primary key of the default portlet layout for the group;
LayoutConstants#DEFAULT_PLID
otherwise - Throws:
PortalException
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getFriendlyURLLayout
public static Layout getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL) throws PortalException Returns the layout for the friendly URL.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupfriendlyURL
- the friendly URL of the layout- Returns:
- the layout for the friendly URL
- Throws:
PortalException
- if a portal exception occurred
-
getIndexableActionableDynamicQuery
-
getLayout
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
public static Layout getLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException Returns the layout matching the layout ID, group, and privacy; throws aNoSuchLayoutException
otherwise.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layout- Returns:
- the matching layout
- Throws:
PortalException
- if a portal exception occurred
-
getLayoutByExternalReferenceCode
public static Layout getLayoutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getLayoutByFriendlyURL
public static Layout getLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) throws PortalException - Throws:
PortalException
-
getLayoutByIconImageId
Returns the layout for the icon image; throws aNoSuchLayoutException
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
public static Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout) throws PortalException Returns the layout matching the UUID, group, and privacy.- Parameters:
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the matching layout
- Throws:
PortalException
- if a matching layout could not be found
-
getLayoutChildLayouts
-
getLayouts
-
getLayouts
Returns a range of all the layouts.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.LayoutModelImpl
.- Parameters:
start
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)- Returns:
- the range of layouts
-
getLayouts
-
getLayouts
Returns all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
Returns all the layouts belonging to the group that are children of the parent layout.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
public static 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layoutincomplete
- whether the layout is incompletestart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end, OrderByComparator<Layout> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layoutstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutIds
- 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
public static 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 groupprivateLayout
- whether the layout is private to the grouptype
- the type of the layouts (optionallyLayoutConstants#TYPE_PORTLET
)- Returns:
- the matching layouts, or
null
if no matches were found - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupkeywords
- keywordstypes
- layout typesstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String[] types) throws PortalException Returns all the layouts that match the type and belong to the group.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptypes
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.- Returns:
- the matching layouts, or
null
if no matches were found - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator) Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found
-
getLayouts
public static List<Layout> getLayouts(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the userprivateLayout
- whether the layout is private to the groupkeywords
- keywordstypes
- layout typesstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException - Throws:
PortalException
-
getLayouts
public static 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 companyportletId
- the primary key of the portletpreferencesKey
- the portlet's preference keypreferencesValue
- the portlet's preference value- Returns:
- the layout references of the matching layouts
-
getLayouts
public static List<Layout> getLayouts(long groupId, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupkeywords
- keywordstypes
- layout typesstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException Returns a range of all the layouts belonging to the group.- Parameters:
groupId
- the primary key of the groupkeywords
- keywordstypes
- layout typesstart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the layouts- Returns:
- the matching layouts, or
null
if no matches were found - Throws:
PortalException
-
getLayoutsByLayoutPrototypeUuid
-
getLayoutsByLayoutPrototypeUuidCount
-
getLayoutsByUuidAndCompanyId
Returns all the layouts matching the UUID and company.- Parameters:
uuid
- the UUID of the layoutscompanyId
- the primary key of the company- Returns:
- the matching layouts, or an empty list if no matches were found
-
getLayoutsByUuidAndCompanyId
public static 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 layoutscompanyId
- the primary key of the companystart
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching layouts, or an empty list if no matches were found
-
getLayoutsCount
public static int getLayoutsCount()Returns the number of layouts.- Returns:
- the number of layouts
-
getLayoutsCount
- Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException - Throws:
PortalException
-
getLayoutsCount
-
getLayoutsCount
-
getLayoutsCount
public static int getLayoutsCount(Group group, boolean privateLayout, String keywords, String[] types) throws PortalException - Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(long groupId) -
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout) -
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId) -
getLayoutsCount
public static int getLayoutsCount(long groupId, long userId, boolean privateLayout, String keywords, String[] types) throws PortalException - Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses) throws PortalException - Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(long groupId, String keywords, String[] types) throws PortalException - Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(long groupId, String keywords, String[] types, int[] statuses) throws PortalException - Throws:
PortalException
-
getLayoutsCount
- Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException - Throws:
PortalException
-
getMasterLayouts
-
getMasterLayoutsCount
public static int getMasterLayoutsCount(long groupId, long masterLayoutPlid) -
getNextLayoutId
public static long getNextLayoutId(long groupId, boolean privateLayout) Returns the layout ID to use for the next layout.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the layout ID to use for the next layout
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getParentLayout
- Throws:
PortalException
-
getPersistedModel
- Throws:
PortalException
-
getPublishedLayouts
public static List<Layout> getPublishedLayouts(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator) -
getPublishedLayoutsCount
public static int getPublishedLayoutsCount(long groupId) -
getScopeGroupLayouts
- Throws:
PortalException
-
getScopeGroupLayouts
public static 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 groupprivateLayout
- whether the layout is private to the group- Returns:
- the layouts within scope of the group
- Throws:
PortalException
- if a portal exception occurred
-
hasLayout
public static boolean hasLayout(String uuid, long groupId, boolean privateLayout) throws PortalException Returnstrue
if there is a matching layout with the UUID, group, and privacy.- Parameters:
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- 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
- Throws:
PortalException
-
hasLayouts
- Throws:
PortalException
-
hasLayouts
public static boolean hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException - Throws:
PortalException
-
hasLayouts
public static boolean hasLayouts(long groupId, boolean privateLayout, long parentLayoutId) Returnstrue
if the group has any layouts;false
otherwise.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout- Returns:
true
if the group has any layouts;false
otherwise
-
hasLayouts
- Throws:
PortalException
-
hasLayouts
public static boolean hasLayouts(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException - Throws:
PortalException
-
hasLayoutSetPrototypeLayout
public static boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid) throws PortalException - Throws:
PortalException
-
hasLayoutSetPrototypeLayout
public static boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, long companyId, String layoutUuid) throws PortalException - Throws:
PortalException
-
search
public static List<Layout> search(long groupId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException - Throws:
PortalException
-
search
public static List<Layout> search(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException - Throws:
PortalException
-
search
public static List<Layout> search(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException - Throws:
PortalException
-
searchCount
public static int searchCount(Group group, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) throws PortalException - Throws:
PortalException
-
searchCount
public static int searchCount(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) throws PortalException - Throws:
PortalException
-
setLayouts
public static 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 groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layoutlayoutIds
- the layout IDs of the layoutsserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
updateAsset
public static void updateAsset(long userId, Layout layout, long[] assetCategoryIds, String[] assetTagNames) throws PortalException - Throws:
PortalException
-
updateFriendlyURL
public static 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 userplid
- the primary key of the layoutfriendlyURL
- the friendly URL to be assignedlanguageId
- the primary key of the language- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateIconImage
- Throws:
PortalException
-
updateLayout
Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
layout
- the layout- Returns:
- the layout that was updated
-
updateLayout
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutpublishDate
- the date when draft was last published- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateLayout
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutclassNameId
- the class name ID of the entityclassPK
- the primary key of the entity- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateLayout
public static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale, String> nameMap, Map<Locale, throws PortalExceptionString> 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, long styleBookEntryId, long faviconFileEntryId, long masterLayoutPlid, ServiceContext serviceContext) Updates the layout.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutparentLayoutId
- the layout ID of the layout's new parent layoutnameMap
- the locales and localized names to merge (optionallynull
)titleMap
- the locales and localized titles to merge (optionallynull
)descriptionMap
- the locales and localized descriptions to merge (optionallynull
)keywordsMap
- the locales and localized keywords to merge (optionallynull
)robotsMap
- the locales and localized robots to merge (optionallynull
)type
- the layout's new type (optionallyLayoutConstants#TYPE_PORTLET
)hidden
- whether the layout is hiddenfriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.normalize(String)
.hasIconImage
- whether the icon image will be updatediconBytes
- the byte array of the layout's new icon imagestyleBookEntryId
- the primary key of the style book entrysfaviconFileEntryId
- the file entry ID of the layout's new faviconmasterLayoutPlid
- the primary key of the master layoutserviceContext
- 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 namedlayoutPrototypeUuid
andlayoutPrototypeLinkedEnabled
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
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layouttypeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateLayout
public static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings, byte[] iconBytes, String themeId, String colorSchemeId, long styleBookEntryId, String css, long faviconFileEntryId, long masterLayoutPlid) throws PortalException - Throws:
PortalException
-
updateLookAndFeel
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutthemeId
- the primary key of the layout's new themecolorSchemeId
- the primary key of the layout's new color schemecss
- the layout's new CSS- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateMasterLayoutPlid
public static Layout updateMasterLayoutPlid(long groupId, boolean privateLayout, long layoutId, long masterLayoutPlid) throws PortalException Updates the layout replacing its master layout plid.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutmasterLayoutPlid
- the primary key of the master layout- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateName
public static Layout updateName(Layout layout, String name, String languageId) throws PortalException Updates the name of the layout.- Parameters:
layout
- the layout to be updatedname
- the layout's new namelanguageId
- the primary key of the language. For more information seeLocale
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateName
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutname
- the layout's new namelanguageId
- the primary key of the language. For more information seeLocale
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateName
Updates the name of the layout matching the primary key.- Parameters:
plid
- the primary key of the layoutname
- the name to be assignedlanguageId
- the primary key of the language. For more information seeLocale
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateParentLayoutId
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutparentLayoutId
- the layout ID to be assigned to the parent layout- Returns:
- the matching layout
- Throws:
PortalException
- if a portal exception occurred
-
updateParentLayoutId
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, otherwiseLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
is assigned.- Parameters:
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layout- Returns:
- the layout matching the primary key
- Throws:
PortalException
- if a portal exception occurred
-
updateParentLayoutIdAndPriority
public static 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 layoutparentPlid
- the primary key of the parent layoutpriority
- the layout's new priority- Returns:
- the layout matching the primary key
- Throws:
PortalException
- if a portal exception occurred
-
updatePriorities
Updates the priorities of the layouts.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Throws:
PortalException
-
updatePriority
Updates the priority of the layout.- Parameters:
layout
- the layout to be updatedpriority
- the layout's new priority- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updatePriority
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutpriority
- the layout's new priority- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updatePriority
public static 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 groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutnextLayoutId
- the layout ID of the next layoutpreviousLayoutId
- the layout ID of the previous layout- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updatePriority
Updates the priority of the layout matching the primary key.- Parameters:
plid
- the primary key of the layoutpriority
- the layout's new priority- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateStatus
public static Layout updateStatus(long userId, long plid, int status, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateStyleBookEntryId
public static Layout updateStyleBookEntryId(long groupId, boolean privateLayout, long layoutId, long styleBookEntryId) throws PortalException Updates the layout replacing its style book entry ID.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutstyleBookEntryId
- the primary key of the style book entry- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateType
- Throws:
PortalException
-
getService
-
setService
-