public class LayoutLocalServiceUtil
extends Object
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.LayoutLocalService
Constructor and Description |
---|
LayoutLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static Layout |
addLayout(Layout layout)
Adds the layout to the database.
|
static 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,
long masterLayoutPlid,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
static 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.
|
static 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.
|
static 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.
|
static 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.
|
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 |
createLayout(long plid)
Creates a new layout with the primary key.
|
static PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
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 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 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 |
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 |
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 |
getActionableDynamicQuery() |
static List<Layout> |
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 group
|
static long |
getDefaultPlid(long groupId,
boolean privateLayout,
String portletId)
Returns primary key of the default portlet layout for the group
|
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
static Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
Returns the layout for the friendly URL.
|
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
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 a
NoSuchLayoutException otherwise. |
static Layout |
getLayoutByFriendlyURL(long groupId,
boolean privateLayout,
String friendlyURL) |
static Layout |
getLayoutByIconImageId(long iconImageId)
Returns the layout for the icon image; throws a
NoSuchLayoutException otherwise. |
static Layout |
getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy.
|
static Map<Long,List<Layout>> |
getLayoutChildLayouts(List<Layout> parentLayouts) |
static List<Layout> |
getLayouts(int start,
int end)
Returns a range of all the layouts.
|
static List<Layout> |
getLayouts(long companyId) |
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout)
Returns all the layouts belonging to the group.
|
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.
|
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.
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
Returns all the layouts belonging to the group that are children of the
parent layout.
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
Returns all the layouts that match the layout IDs and belong to the
group.
|
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.
|
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.
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type)
Returns all the layouts that match the type and belong to the group.
|
static List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String[] types)
Returns all the layouts that match the type and belong to the group.
|
static List<Layout> |
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.
|
static List<Layout> |
getLayouts(long groupId,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of all the layouts belonging to the group.
|
static List<Layout> |
getLayouts(long groupId,
long userId,
boolean privateLayout,
String keywords,
String[] types,
int[] statuses,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
static List<Layout> |
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.
|
static List<Layout> |
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.
|
static List<Layout> |
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.
|
static List<Layout> |
getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid) |
static int |
getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid) |
static List<Layout> |
getLayoutsByUuidAndCompanyId(String uuid,
long companyId)
Returns all the layouts matching the UUID and company.
|
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.
|
static int |
getLayoutsCount()
Returns the number of layouts.
|
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(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(User user,
boolean privateLayout) |
static int |
getLayoutsCount(User user,
boolean privateLayout,
boolean includeUserGroups) |
static List<Layout> |
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 |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static Layout |
getParentLayout(Layout layout) |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static List<Layout> |
getPublishedLayouts(long groupId,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
static int |
getPublishedLayoutsCount(long groupId) |
static List<Layout> |
getScopeGroupLayouts(long parentGroupId) |
static List<Layout> |
getScopeGroupLayouts(long parentGroupId,
boolean privateLayout)
Returns all the layouts within scope of the group.
|
static LayoutLocalService |
getService() |
static boolean |
hasLayout(String uuid,
long groupId,
boolean privateLayout)
Returns
true if there is a matching layout with the UUID,
group, and privacy. |
static boolean |
hasLayouts(Group group) |
static boolean |
hasLayouts(Group group,
boolean privateLayout) |
static boolean |
hasLayouts(Group group,
boolean privateLayout,
boolean includeUserGroups) |
static boolean |
hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
Returns
true if the group has any layouts;
false otherwise. |
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) |
static List<Layout> |
search(long groupId,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
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) |
static List<Layout> |
search(long groupId,
long userId,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
static int |
searchCount(Group group,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types) |
static int |
searchCount(long groupId,
long userId,
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(Layout layout)
Updates the layout in the database or adds it if it does not yet exist.
|
static Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
Date publishDate)
Updates the layout replacing its draft publish date.
|
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 |
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(Layout layout,
String name,
String languageId)
Updates the name of the layout.
|
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 |
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(Layout layout,
int priority)
Updates the priority of the layout.
|
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 |
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) |
public static Layout addLayout(Layout layout)
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.
layout
- the layoutpublic static 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, long masterLayoutPlid, ServiceContext serviceContext) throws PortalException
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.
userId
- 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 (optionally
LayoutConstants#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 (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 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, see FriendlyURLNormalizerUtil.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 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.PortalException
- if a portal exception occurredpublic static 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
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.
userId
- 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 (optionally
LayoutConstants#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 (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 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, 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.PortalException
- if a portal exception occurredpublic static 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
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.
userId
- 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 (optionally
LayoutConstants#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 (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 hiddenfriendlyURLMap
- 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.PortalException
- if a portal exception occurredpublic static 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
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.
userId
- 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 (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 titledescription
- the layout's descriptiontype
- the layout's type (optionally LayoutConstants#TYPE_PORTLET
). The possible types can be found
in LayoutConstants
.hidden
- whether the layout is hiddensystem
- whether the layout is of system typefriendlyURL
- 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.PortalException
- if a portal exception occurredpublic static 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
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.
userId
- 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 (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 titledescription
- the layout's descriptiontype
- the layout's type (optionally LayoutConstants#TYPE_PORTLET
). The possible types can be found
in LayoutConstants
.hidden
- whether the layout is hiddenfriendlyURL
- 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.PortalException
- if a portal exception occurredpublic 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
PortalException
public static Layout createLayout(long plid)
plid
- the primary key for the new layoutpublic static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static Layout deleteLayout(Layout layout) throws PortalException
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.
layout
- the layoutPortalException
public static void deleteLayout(Layout layout, ServiceContext serviceContext) throws PortalException
layout
- the layoutserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic static Layout deleteLayout(long plid) throws PortalException
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.
plid
- the primary key of the layoutPortalException
- if a layout with the primary key could not be foundpublic static void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext) throws PortalException
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 appliedPortalException
- if a portal exception occurredpublic static void deleteLayout(long plid, ServiceContext serviceContext) throws PortalException
plid
- the primary key of the layoutserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic static void deleteLayouts(long groupId, boolean privateLayout, ServiceContext serviceContext) throws PortalException
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 named updatePageCount
is set to
false
.PortalException
- if a portal exception occurredpublic static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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
.
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 (optionally null
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static Layout fetchDefaultLayout(long groupId, boolean privateLayout)
public static Layout fetchDraftLayout(long plid)
public static Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId)
public static Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId, boolean hidden)
public static Layout fetchLayout(long plid)
public static Layout fetchLayout(long groupId, boolean privateLayout, long layoutId)
public static Layout fetchLayout(long classNameId, long classPK)
public static Layout fetchLayout(String uuid, long groupId, boolean privateLayout)
public static Layout fetchLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL)
public static Layout fetchLayoutByIconImageId(boolean privateLayout, long iconImageId) throws PortalException
PortalException
public static Layout fetchLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupnull
if a matching layout could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static List<Layout> getAllLayouts(long groupId, boolean privateLayout, String type) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptype
- the type of the layouts (optiona.lly LayoutConstants#TYPE_PORTLET
)PortalException
public static long getDefaultPlid(long groupId)
groupId
- the primary key of the groupLayoutConstants#DEFAULT_PLID
)public static long getDefaultPlid(long groupId, boolean privateLayout)
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupLayoutConstants#DEFAULT_PLID
) otherwisepublic static long getDefaultPlid(long groupId, boolean privateLayout, String portletId) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupportletId
- the primary key of the portletLayoutConstants#DEFAULT_PLID
otherwisePortalException
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static Layout getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupfriendlyURL
- the friendly URL of the layoutPortalException
- if a portal exception occurredpublic static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static Layout getLayout(long plid) throws PortalException
plid
- the primary key of the layoutPortalException
- if a layout with the primary key could not be foundpublic static Layout getLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException
NoSuchLayoutException
otherwise.groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutPortalException
- if a portal exception occurredpublic static Layout getLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) throws PortalException
PortalException
public static Layout getLayoutByIconImageId(long iconImageId) throws PortalException
NoSuchLayoutException
otherwise.iconImageId
- the primary key of the icon imagePortalException
- if a portal exception occurredpublic static Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout) throws PortalException
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupPortalException
- if a matching layout could not be foundpublic static Map<Long,List<Layout>> getLayoutChildLayouts(List<Layout> parentLayouts)
public static List<Layout> getLayouts(int start, int end)
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
.
start
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)public static List<Layout> getLayouts(long companyId)
public static List<Layout> getLayouts(long groupId, boolean privateLayout)
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupnull
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, int start, int end, OrderByComparator<Layout> orderByComparator)
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 layoutsnull
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator)
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 layoutsnull
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layoutnull
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)
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.
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)null
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end, OrderByComparator<Layout> orderByComparator)
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.
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 layoutsnull
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, long[] layoutIds) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutIds
- the layout IDs of the layoutsPortalException
- if a portal exception occurredpublic static List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptype
- the type of the layouts (optionally LayoutConstants#TYPE_PORTLET
)null
if no matches were
foundPortalException
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
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 layoutsnull
if no matches were
foundPortalException
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String[] types) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptypes
- the layout's type (optionally LayoutConstants#TYPE_PORTLET
). The possible types can be found
in LayoutConstants
.null
if no matches were
foundPortalException
public static List<Layout> getLayouts(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator)
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 layoutsnull
if no matches were
foundpublic static List<Layout> getLayouts(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
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 layoutsnull
if no matches were
foundPortalException
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
PortalException
public static LayoutReference[] getLayouts(long companyId, String portletId, String preferencesKey, String preferencesValue)
companyId
- the primary key of the companyportletId
- the primary key of the portletpreferencesKey
- the portlet's preference keypreferencesValue
- the portlet's preference valuepublic static List<Layout> getLayouts(long groupId, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
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 layoutsnull
if no matches were
foundPortalException
public static List<Layout> getLayouts(long groupId, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
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 layoutsnull
if no matches were
foundPortalException
public static List<Layout> getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)
public static int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
public static List<Layout> getLayoutsByUuidAndCompanyId(String uuid, long companyId)
uuid
- the UUID of the layoutscompanyId
- the primary key of the companypublic static List<Layout> getLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Layout> orderByComparator)
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 (optionally null
)public static int getLayoutsCount()
public static int getLayoutsCount(Group group, boolean privateLayout) throws PortalException
PortalException
public static int getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException
PortalException
public static int getLayoutsCount(Group group, boolean privateLayout, long parentLayoutId)
public static int getLayoutsCount(Group group, boolean privateLayout, long[] layoutIds)
public static int getLayoutsCount(Group group, boolean privateLayout, String keywords, String[] types) throws PortalException
PortalException
public static int getLayoutsCount(long groupId)
public static int getLayoutsCount(long groupId, boolean privateLayout)
public static int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
public static int getLayoutsCount(long groupId, long userId, boolean privateLayout, String keywords, String[] types) throws PortalException
PortalException
public static int getLayoutsCount(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses) throws PortalException
PortalException
public static int getLayoutsCount(long groupId, String keywords, String[] types) throws PortalException
PortalException
public static int getLayoutsCount(long groupId, String keywords, String[] types, int[] statuses) throws PortalException
PortalException
public static int getLayoutsCount(User user, boolean privateLayout) throws PortalException
PortalException
public static int getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException
PortalException
public static List<Layout> getMasterLayouts(long groupId, long masterLayoutPlid)
public static int getMasterLayoutsCount(long groupId, long masterLayoutPlid)
public static long getNextLayoutId(long groupId, boolean privateLayout)
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouppublic static String getOSGiServiceIdentifier()
public static Layout getParentLayout(Layout layout) throws PortalException
PortalException
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static List<Layout> getPublishedLayouts(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator)
public static int getPublishedLayoutsCount(long groupId)
public static List<Layout> getScopeGroupLayouts(long parentGroupId) throws PortalException
PortalException
public static List<Layout> getScopeGroupLayouts(long parentGroupId, boolean privateLayout) throws PortalException
parentGroupId
- the primary key of the group's parent groupprivateLayout
- whether the layout is private to the groupPortalException
- if a portal exception occurredpublic static boolean hasLayout(String uuid, long groupId, boolean privateLayout) throws PortalException
true
if there is a matching layout with the UUID,
group, and privacy.uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouptrue
if the layout is found; false
otherwisePortalException
- if a portal exception occurredpublic static boolean hasLayouts(Group group) throws PortalException
PortalException
public static boolean hasLayouts(Group group, boolean privateLayout) throws PortalException
PortalException
public static boolean hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException
PortalException
public static boolean hasLayouts(long groupId, boolean privateLayout, long parentLayoutId)
true
if the group has any layouts;
false
otherwise.groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layouttrue
if the group has any layouts;
false
otherwisepublic static boolean hasLayouts(User user, boolean privateLayout) throws PortalException
PortalException
public static boolean hasLayouts(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException
PortalException
public static boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid) throws PortalException
PortalException
public static boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, long companyId, String layoutUuid) throws PortalException
PortalException
public static List<Layout> search(long groupId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
PortalException
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
PortalException
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
PortalException
public static int searchCount(Group group, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) throws PortalException
PortalException
public static int searchCount(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) throws PortalException
PortalException
public static void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext) throws PortalException
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 appliedPortalException
- if a portal exception occurredpublic static void updateAsset(long userId, Layout layout, long[] assetCategoryIds, String[] assetTagNames) throws PortalException
PortalException
public static Layout updateFriendlyURL(long userId, long plid, String friendlyURL, String languageId) throws PortalException
userId
- the primary key of the userplid
- the primary key of the layoutfriendlyURL
- the friendly URL to be assignedlanguageId
- the primary key of the languagePortalException
- if a portal exception occurredpublic static Layout updateIconImage(long plid, byte[] bytes) throws PortalException
PortalException
public static Layout updateLayout(Layout layout)
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.
layout
- the layoutpublic static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, Date publishDate) throws PortalException
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 publishedPortalException
- if a portal exception occurredpublic static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long classNameId, long classPK) throws PortalException
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 entityPortalException
- if a portal exception occurredpublic 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) throws PortalException
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 (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 hiddenfriendlyURLMap
- 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 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
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.PortalException
- if a portal exception occurredpublic static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException
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)
.PortalException
- if a portal exception occurredpublic 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
PortalException
public static Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css) throws PortalException
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 CSSPortalException
- if a portal exception occurredpublic static Layout updateMasterLayoutPlid(long groupId, boolean privateLayout, long layoutId, long masterLayoutPlid) throws PortalException
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 layoutPortalException
- if a portal exception occurredpublic static Layout updateName(Layout layout, String name, String languageId) throws PortalException
layout
- the layout to be updatedname
- the layout's new namelanguageId
- the primary key of the language. For more information
see Locale
.PortalException
- if a portal exception occurredpublic static Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException
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
see Locale
.PortalException
- if a portal exception occurredpublic static Layout updateName(long plid, String name, String languageId) throws PortalException
plid
- the primary key of the layoutname
- the name to be assignedlanguageId
- the primary key of the language. For more information
see Locale
.PortalException
- if a portal exception occurredpublic static Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException
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 layoutPortalException
- if a portal exception occurredpublic static Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID
is assigned.plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutPortalException
- if a portal exception occurredpublic static Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic static void updatePriorities(long groupId, boolean privateLayout) throws PortalException
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupPortalException
public static Layout updatePriority(Layout layout, int priority) throws PortalException
layout
- the layout to be updatedpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException
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 priorityPortalException
- if a portal exception occurredpublic static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) throws PortalException
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 layoutPortalException
- if a portal exception occurredpublic static Layout updatePriority(long plid, int priority) throws PortalException
plid
- the primary key of the layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic static Layout updateStatus(long userId, long plid, int status, ServiceContext serviceContext) throws PortalException
PortalException
public static Layout updateStyleBookEntryId(long groupId, boolean privateLayout, long layoutId, long styleBookEntryId) throws PortalException
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 entryPortalException
- if a portal exception occurredpublic static Layout updateType(long plid, String type) throws PortalException
PortalException
public static LayoutLocalService getService()
public static void setService(LayoutLocalService service)