public class LayoutLocalServiceWrapper extends Object implements LayoutLocalService, ServiceWrapper<LayoutLocalService>
LayoutLocalService
.LayoutLocalService
Constructor and Description |
---|
LayoutLocalServiceWrapper() |
LayoutLocalServiceWrapper(LayoutLocalService layoutLocalService) |
Modifier and Type | Method and Description |
---|---|
Layout |
addLayout(Layout layout)
Adds the layout to the database.
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
long classNameId,
long classPK,
Map<Locale,String> nameMap,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
Map<Locale,String> keywordsMap,
Map<Locale,String> robotsMap,
String type,
String typeSettings,
boolean hidden,
boolean system,
Map<Locale,String> friendlyURLMap,
long masterLayoutPlid,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> nameMap,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
Map<Locale,String> keywordsMap,
Map<Locale,String> robotsMap,
String type,
String typeSettings,
boolean hidden,
boolean system,
Map<Locale,String> friendlyURLMap,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
Map<Locale,String> nameMap,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
Map<Locale,String> keywordsMap,
Map<Locale,String> robotsMap,
String type,
String typeSettings,
boolean hidden,
Map<Locale,String> friendlyURLMap,
ServiceContext serviceContext)
Adds a layout with additional parameters.
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
boolean system,
String friendlyURL,
ServiceContext serviceContext)
Adds a layout with single entry maps for name, title, and description to
the default locale.
|
Layout |
addLayout(long userId,
long groupId,
boolean privateLayout,
long parentLayoutId,
String name,
String title,
String description,
String type,
boolean hidden,
String friendlyURL,
ServiceContext serviceContext)
Adds a layout with single entry maps for name, title, and description to
the default locale.
|
Layout |
copyLayout(long userId,
long groupId,
boolean privateLayout,
Map<Locale,String> nameMap,
boolean hidden,
boolean system,
boolean copyPermissions,
long sourcePlid,
ServiceContext serviceContext) |
Layout |
createLayout(long plid)
Creates a new layout with the primary key.
|
PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
Layout |
deleteLayout(Layout layout)
Deletes the layout from the database.
|
void |
deleteLayout(Layout layout,
ServiceContext serviceContext)
Deletes the layout, its child layouts, and its associated resources.
|
Layout |
deleteLayout(long plid)
Deletes the layout with the primary key from the database.
|
void |
deleteLayout(long groupId,
boolean privateLayout,
long layoutId,
ServiceContext serviceContext)
Deletes the layout with the layout ID, also deleting the layout's child
layouts, and associated resources.
|
void |
deleteLayout(long plid,
ServiceContext serviceContext)
Deletes the layout with the plid, also deleting the layout's child
layouts, and associated resources.
|
void |
deleteLayouts(long groupId,
boolean privateLayout,
ServiceContext serviceContext)
Deletes the group's private or non-private layouts, also deleting the
layouts' child layouts, and associated resources.
|
PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
<T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
DynamicQuery |
dynamicQuery() |
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
Layout |
fetchDefaultLayout(long groupId,
boolean privateLayout) |
Layout |
fetchDraftLayout(long plid) |
Layout |
fetchFirstLayout(long groupId,
boolean privateLayout,
long parentLayoutId) |
Layout |
fetchFirstLayout(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean hidden) |
Layout |
fetchLayout(long plid) |
Layout |
fetchLayout(long groupId,
boolean privateLayout,
long layoutId) |
Layout |
fetchLayout(long classNameId,
long classPK) |
Layout |
fetchLayout(String uuid,
long groupId,
boolean privateLayout) |
Layout |
fetchLayoutByFriendlyURL(long groupId,
boolean privateLayout,
String friendlyURL) |
Layout |
fetchLayoutByIconImageId(boolean privateLayout,
long iconImageId) |
Layout |
fetchLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy.
|
ActionableDynamicQuery |
getActionableDynamicQuery() |
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.
|
BasePersistence<?> |
getBasePersistence() |
Layout |
getBrowsableLayout(Layout layout) |
CTPersistence<Layout> |
getCTPersistence() |
long |
getDefaultPlid(long groupId)
Returns the primary key of the default layout for the group.
|
long |
getDefaultPlid(long groupId,
boolean privateLayout)
Returns primary key of the matching default layout for the group
|
long |
getDefaultPlid(long groupId,
boolean privateLayout,
String portletId)
Returns primary key of the default portlet layout for the group
|
ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
Layout |
getFriendlyURLLayout(long groupId,
boolean privateLayout,
String friendlyURL)
Returns the layout for the friendly URL.
|
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
Layout |
getLayout(long plid)
Returns the layout with the primary key.
|
Layout |
getLayout(long groupId,
boolean privateLayout,
long layoutId)
Returns the layout matching the layout ID, group, and privacy; throws a
NoSuchLayoutException otherwise. |
Layout |
getLayoutByFriendlyURL(long groupId,
boolean privateLayout,
String friendlyURL) |
Layout |
getLayoutByIconImageId(long iconImageId)
Returns the layout for the icon image; throws a
NoSuchLayoutException otherwise. |
Layout |
getLayoutByUuidAndGroupId(String uuid,
long groupId,
boolean privateLayout)
Returns the layout matching the UUID, group, and privacy.
|
Map<Long,List<Layout>> |
getLayoutChildLayouts(List<Layout> parentLayouts) |
List<Layout> |
getLayouts(int start,
int end)
Returns a range of all the layouts.
|
List<Layout> |
getLayouts(long companyId) |
List<Layout> |
getLayouts(long groupId,
boolean privateLayout)
Returns all the layouts belonging to the group.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
int[] statuses,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of all the layouts belonging to the group.
|
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.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
Returns all the layouts belonging to the group that are children of the
parent layout.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long[] layoutIds)
Returns all the layouts that match the layout IDs and belong to the
group.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end)
Returns a range of all the layouts belonging to the group that are
children of the parent layout.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
boolean incomplete,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of all the layouts belonging to the group that are
children of the parent layout.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String type)
Returns all the layouts that match the type and belong to the group.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String[] types)
Returns all the layouts that match the type and belong to the group.
|
List<Layout> |
getLayouts(long groupId,
boolean privateLayout,
String keywords,
String[] types,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of all the layouts belonging to the group.
|
List<Layout> |
getLayouts(long groupId,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of all the layouts belonging to the group.
|
List<Layout> |
getLayouts(long groupId,
long userId,
boolean privateLayout,
String keywords,
String[] types,
int[] statuses,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
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.
|
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.
|
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.
|
LayoutReference[] |
getLayouts(long companyId,
String portletId,
String preferencesKey,
String preferencesValue)
Returns the layout references for all the layouts that belong to the
company and belong to the portlet that matches the preferences.
|
List<Layout> |
getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid) |
int |
getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid) |
List<Layout> |
getLayoutsByUuidAndCompanyId(String uuid,
long companyId)
Returns all the layouts matching the UUID and company.
|
List<Layout> |
getLayoutsByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<Layout> orderByComparator)
Returns a range of layouts matching the UUID and company.
|
int |
getLayoutsCount()
Returns the number of layouts.
|
int |
getLayoutsCount(Group group,
boolean privateLayout) |
int |
getLayoutsCount(Group group,
boolean privateLayout,
boolean includeUserGroups) |
int |
getLayoutsCount(Group group,
boolean privateLayout,
long parentLayoutId) |
int |
getLayoutsCount(Group group,
boolean privateLayout,
long[] layoutIds) |
int |
getLayoutsCount(Group group,
boolean privateLayout,
String keywords,
String[] types) |
int |
getLayoutsCount(long groupId) |
int |
getLayoutsCount(long groupId,
boolean privateLayout) |
int |
getLayoutsCount(long groupId,
boolean privateLayout,
long parentLayoutId) |
int |
getLayoutsCount(long groupId,
long userId,
boolean privateLayout,
String keywords,
String[] types) |
int |
getLayoutsCount(long groupId,
long userId,
boolean privateLayout,
String keywords,
String[] types,
int[] statuses) |
int |
getLayoutsCount(long groupId,
String keywords,
String[] types) |
int |
getLayoutsCount(long groupId,
String keywords,
String[] types,
int[] statuses) |
int |
getLayoutsCount(User user,
boolean privateLayout) |
int |
getLayoutsCount(User user,
boolean privateLayout,
boolean includeUserGroups) |
List<Layout> |
getMasterLayouts(long groupId,
long masterLayoutPlid) |
int |
getMasterLayoutsCount(long groupId,
long masterLayoutPlid) |
Class<Layout> |
getModelClass() |
long |
getNextLayoutId(long groupId,
boolean privateLayout)
Returns the layout ID to use for the next layout.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
Layout |
getParentLayout(Layout layout) |
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
List<Layout> |
getPublishedLayouts(long groupId,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
int |
getPublishedLayoutsCount(long groupId) |
List<Layout> |
getScopeGroupLayouts(long parentGroupId) |
List<Layout> |
getScopeGroupLayouts(long parentGroupId,
boolean privateLayout)
Returns all the layouts within scope of the group.
|
LayoutLocalService |
getWrappedService() |
boolean |
hasLayout(String uuid,
long groupId,
boolean privateLayout)
Returns
true if there is a matching layout with the UUID,
group, and privacy. |
boolean |
hasLayouts(Group group) |
boolean |
hasLayouts(Group group,
boolean privateLayout) |
boolean |
hasLayouts(Group group,
boolean privateLayout,
boolean includeUserGroups) |
boolean |
hasLayouts(long groupId,
boolean privateLayout,
long parentLayoutId)
Returns
true if the group has any layouts;
false otherwise. |
boolean |
hasLayouts(User user,
boolean privateLayout) |
boolean |
hasLayouts(User user,
boolean privateLayout,
boolean includeUserGroups) |
boolean |
hasLayoutSetPrototypeLayout(long layoutSetPrototypeId,
String layoutUuid) |
boolean |
hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid,
long companyId,
String layoutUuid) |
List<Layout> |
search(long groupId,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
List<Layout> |
search(long groupId,
long userId,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types,
int[] statuses,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
List<Layout> |
search(long groupId,
long userId,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types,
int start,
int end,
OrderByComparator<Layout> orderByComparator) |
int |
searchCount(Group group,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types) |
int |
searchCount(long groupId,
long userId,
boolean privateLayout,
String keywords,
boolean searchOnlyByTitle,
String[] types) |
void |
setLayouts(long groupId,
boolean privateLayout,
long parentLayoutId,
long[] layoutIds,
ServiceContext serviceContext)
Sets the layouts for the group, replacing and prioritizing all layouts of
the parent layout.
|
void |
setWrappedService(LayoutLocalService layoutLocalService) |
void |
updateAsset(long userId,
Layout layout,
long[] assetCategoryIds,
String[] assetTagNames) |
Layout |
updateFriendlyURL(long userId,
long plid,
String friendlyURL,
String languageId)
Updates the friendly URL of the layout.
|
Layout |
updateIconImage(long plid,
byte[] bytes) |
Layout |
updateLayout(Layout layout)
Updates the layout in the database or adds it if it does not yet exist.
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
Date publishDate)
Updates the layout replacing its draft publish date.
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long classNameId,
long classPK)
Updates the layout replacing its entity class name ID and primary key.
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId,
Map<Locale,String> nameMap,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
Map<Locale,String> keywordsMap,
Map<Locale,String> robotsMap,
String type,
boolean hidden,
Map<Locale,String> friendlyURLMap,
boolean hasIconImage,
byte[] iconBytes,
long styleBookEntryId,
long faviconFileEntryId,
long masterLayoutPlid,
ServiceContext serviceContext)
Updates the layout.
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings)
Updates the layout replacing its type settings.
|
Layout |
updateLayout(long groupId,
boolean privateLayout,
long layoutId,
String typeSettings,
byte[] iconBytes,
String themeId,
String colorSchemeId,
long styleBookEntryId,
String css,
long faviconFileEntryId,
long masterLayoutPlid) |
Layout |
updateLookAndFeel(long groupId,
boolean privateLayout,
long layoutId,
String themeId,
String colorSchemeId,
String css)
Updates the look and feel of the layout.
|
Layout |
updateMasterLayoutPlid(long groupId,
boolean privateLayout,
long layoutId,
long masterLayoutPlid)
Updates the layout replacing its master layout plid.
|
Layout |
updateName(Layout layout,
String name,
String languageId)
Updates the name of the layout.
|
Layout |
updateName(long groupId,
boolean privateLayout,
long layoutId,
String name,
String languageId)
Updates the name of the layout matching the group, layout ID, and
privacy.
|
Layout |
updateName(long plid,
String name,
String languageId)
Updates the name of the layout matching the primary key.
|
Layout |
updateParentLayoutId(long groupId,
boolean privateLayout,
long layoutId,
long parentLayoutId)
Updates the parent layout ID of the layout matching the group, layout ID,
and privacy.
|
Layout |
updateParentLayoutId(long plid,
long parentPlid)
Updates the parent layout ID of the layout matching the primary key.
|
Layout |
updateParentLayoutIdAndPriority(long plid,
long parentPlid,
int priority)
Updates the parent layout ID and priority of the layout.
|
void |
updatePriorities(long groupId,
boolean privateLayout)
Updates the priorities of the layouts.
|
Layout |
updatePriority(Layout layout,
int priority)
Updates the priority of the layout.
|
Layout |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
int priority)
Updates the priority of the layout matching the group, layout ID, and
privacy.
|
Layout |
updatePriority(long groupId,
boolean privateLayout,
long layoutId,
long nextLayoutId,
long previousLayoutId)
Updates the priority of the layout matching the group, layout ID, and
privacy, setting the layout's priority based on the priorities of the
next and previous layouts.
|
Layout |
updatePriority(long plid,
int priority)
Updates the priority of the layout matching the primary key.
|
Layout |
updateStatus(long userId,
long plid,
int status,
ServiceContext serviceContext) |
Layout |
updateStyleBookEntryId(long groupId,
boolean privateLayout,
long layoutId,
long styleBookEntryId)
Updates the layout replacing its style book entry ID.
|
Layout |
updateType(long plid,
String type) |
<R,E extends Throwable> |
updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Layout>,R,E> updateUnsafeFunction) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
fetchPersistedModel
public LayoutLocalServiceWrapper()
public LayoutLocalServiceWrapper(LayoutLocalService layoutLocalService)
public 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.
addLayout
in interface LayoutLocalService
layout
- the layoutpublic 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.
addLayout
in interface LayoutLocalService
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 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.
addLayout
in interface LayoutLocalService
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 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.
addLayout
in interface LayoutLocalService
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 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.
addLayout
in interface LayoutLocalService
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 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.
addLayout
in interface LayoutLocalService
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 Layout copyLayout(long userId, long groupId, boolean privateLayout, Map<Locale,String> nameMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) throws PortalException
copyLayout
in interface LayoutLocalService
PortalException
public Layout createLayout(long plid)
createLayout
in interface LayoutLocalService
plid
- the primary key for the new layoutpublic PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
createPersistedModel
in interface LayoutLocalService
createPersistedModel
in interface PersistedModelLocalService
PortalException
public 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.
deleteLayout
in interface LayoutLocalService
layout
- the layoutPortalException
public void deleteLayout(Layout layout, ServiceContext serviceContext) throws PortalException
deleteLayout
in interface LayoutLocalService
layout
- the layoutserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic 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.
deleteLayout
in interface LayoutLocalService
plid
- the primary key of the layoutPortalException
- if a layout with the primary key could not be foundpublic void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext) throws PortalException
deleteLayout
in interface LayoutLocalService
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 void deleteLayout(long plid, ServiceContext serviceContext) throws PortalException
deleteLayout
in interface LayoutLocalService
plid
- the primary key of the layoutserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredpublic void deleteLayouts(long groupId, boolean privateLayout, ServiceContext serviceContext) throws PortalException
deleteLayouts
in interface LayoutLocalService
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 PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface LayoutLocalService
deletePersistedModel
in interface PersistedModelLocalService
PortalException
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface LayoutLocalService
dslQuery
in interface PersistedModelLocalService
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface LayoutLocalService
dslQueryCount
in interface PersistedModelLocalService
public DynamicQuery dynamicQuery()
dynamicQuery
in interface LayoutLocalService
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
in interface LayoutLocalService
dynamicQuery
- the dynamic querypublic <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
in interface LayoutLocalService
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 <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
in interface LayoutLocalService
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 long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQueryCount
in interface LayoutLocalService
dynamicQuery
- the dynamic querypublic long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQueryCount
in interface LayoutLocalService
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic Layout fetchDefaultLayout(long groupId, boolean privateLayout)
fetchDefaultLayout
in interface LayoutLocalService
public Layout fetchDraftLayout(long plid)
fetchDraftLayout
in interface LayoutLocalService
public Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId)
fetchFirstLayout
in interface LayoutLocalService
public Layout fetchFirstLayout(long groupId, boolean privateLayout, long parentLayoutId, boolean hidden)
fetchFirstLayout
in interface LayoutLocalService
public Layout fetchLayout(long plid)
fetchLayout
in interface LayoutLocalService
public Layout fetchLayout(long groupId, boolean privateLayout, long layoutId)
fetchLayout
in interface LayoutLocalService
public Layout fetchLayout(long classNameId, long classPK)
fetchLayout
in interface LayoutLocalService
public Layout fetchLayout(String uuid, long groupId, boolean privateLayout)
fetchLayout
in interface LayoutLocalService
public Layout fetchLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL)
fetchLayoutByFriendlyURL
in interface LayoutLocalService
public Layout fetchLayoutByIconImageId(boolean privateLayout, long iconImageId) throws PortalException
fetchLayoutByIconImageId
in interface LayoutLocalService
PortalException
public Layout fetchLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout)
fetchLayoutByUuidAndGroupId
in interface LayoutLocalService
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 ActionableDynamicQuery getActionableDynamicQuery()
getActionableDynamicQuery
in interface LayoutLocalService
public List<Layout> getAllLayouts(long groupId, boolean privateLayout, String type) throws PortalException
getAllLayouts
in interface LayoutLocalService
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 Layout getBrowsableLayout(Layout layout)
getBrowsableLayout
in interface LayoutLocalService
public long getDefaultPlid(long groupId)
getDefaultPlid
in interface LayoutLocalService
groupId
- the primary key of the groupLayoutConstants#DEFAULT_PLID
)public long getDefaultPlid(long groupId, boolean privateLayout)
getDefaultPlid
in interface LayoutLocalService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupLayoutConstants#DEFAULT_PLID
) otherwisepublic long getDefaultPlid(long groupId, boolean privateLayout, String portletId) throws PortalException
getDefaultPlid
in interface LayoutLocalService
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 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
getExportActionableDynamicQuery
in interface LayoutLocalService
public Layout getFriendlyURLLayout(long groupId, boolean privateLayout, String friendlyURL) throws PortalException
getFriendlyURLLayout
in interface LayoutLocalService
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 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
getIndexableActionableDynamicQuery
in interface LayoutLocalService
public Layout getLayout(long plid) throws PortalException
getLayout
in interface LayoutLocalService
plid
- the primary key of the layoutPortalException
- if a layout with the primary key could not be foundpublic Layout getLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException
NoSuchLayoutException
otherwise.getLayout
in interface LayoutLocalService
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 Layout getLayoutByFriendlyURL(long groupId, boolean privateLayout, String friendlyURL) throws PortalException
getLayoutByFriendlyURL
in interface LayoutLocalService
PortalException
public Layout getLayoutByIconImageId(long iconImageId) throws PortalException
NoSuchLayoutException
otherwise.getLayoutByIconImageId
in interface LayoutLocalService
iconImageId
- the primary key of the icon imagePortalException
- if a portal exception occurredpublic Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout) throws PortalException
getLayoutByUuidAndGroupId
in interface LayoutLocalService
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 Map<Long,List<Layout>> getLayoutChildLayouts(List<Layout> parentLayouts)
getLayoutChildLayouts
in interface LayoutLocalService
public 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
.
getLayouts
in interface LayoutLocalService
start
- the lower bound of the range of layoutsend
- the upper bound of the range of layouts (not inclusive)public List<Layout> getLayouts(long companyId)
getLayouts
in interface LayoutLocalService
public List<Layout> getLayouts(long groupId, boolean privateLayout)
getLayouts
in interface LayoutLocalService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupnull
if no matches were
foundpublic List<Layout> getLayouts(long groupId, boolean privateLayout, int start, int end, OrderByComparator<Layout> orderByComparator)
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, boolean privateLayout, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator)
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
getLayouts
in interface LayoutLocalService
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 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.
getLayouts
in interface LayoutLocalService
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 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.
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, boolean privateLayout, long[] layoutIds) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, boolean privateLayout, String[] types) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator)
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutLocalService
PortalException
public LayoutReference[] getLayouts(long companyId, String portletId, String preferencesKey, String preferencesValue)
getLayouts
in interface LayoutLocalService
companyId
- the primary key of the companyportletId
- the primary key of the portletpreferencesKey
- the portlet's preference keypreferencesValue
- the portlet's preference valuepublic List<Layout> getLayouts(long groupId, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayouts(long groupId, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
getLayouts
in interface LayoutLocalService
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 List<Layout> getLayoutsByLayoutPrototypeUuid(String layoutPrototypeUuid)
getLayoutsByLayoutPrototypeUuid
in interface LayoutLocalService
public int getLayoutsByLayoutPrototypeUuidCount(String layoutPrototypeUuid)
getLayoutsByLayoutPrototypeUuidCount
in interface LayoutLocalService
public List<Layout> getLayoutsByUuidAndCompanyId(String uuid, long companyId)
getLayoutsByUuidAndCompanyId
in interface LayoutLocalService
uuid
- the UUID of the layoutscompanyId
- the primary key of the companypublic List<Layout> getLayoutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<Layout> orderByComparator)
getLayoutsByUuidAndCompanyId
in interface LayoutLocalService
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 int getLayoutsCount()
getLayoutsCount
in interface LayoutLocalService
public int getLayoutsCount(Group group, boolean privateLayout) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(Group group, boolean privateLayout, long parentLayoutId)
getLayoutsCount
in interface LayoutLocalService
public int getLayoutsCount(Group group, boolean privateLayout, long[] layoutIds)
getLayoutsCount
in interface LayoutLocalService
public int getLayoutsCount(Group group, boolean privateLayout, String keywords, String[] types) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(long groupId)
getLayoutsCount
in interface LayoutLocalService
public int getLayoutsCount(long groupId, boolean privateLayout)
getLayoutsCount
in interface LayoutLocalService
public int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
getLayoutsCount
in interface LayoutLocalService
public int getLayoutsCount(long groupId, long userId, boolean privateLayout, String keywords, String[] types) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(long groupId, long userId, boolean privateLayout, String keywords, String[] types, int[] statuses) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(long groupId, String keywords, String[] types) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(long groupId, String keywords, String[] types, int[] statuses) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(User user, boolean privateLayout) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public int getLayoutsCount(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException
getLayoutsCount
in interface LayoutLocalService
PortalException
public List<Layout> getMasterLayouts(long groupId, long masterLayoutPlid)
getMasterLayouts
in interface LayoutLocalService
public int getMasterLayoutsCount(long groupId, long masterLayoutPlid)
getMasterLayoutsCount
in interface LayoutLocalService
public long getNextLayoutId(long groupId, boolean privateLayout)
getNextLayoutId
in interface LayoutLocalService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouppublic String getOSGiServiceIdentifier()
getOSGiServiceIdentifier
in interface LayoutLocalService
public Layout getParentLayout(Layout layout) throws PortalException
getParentLayout
in interface LayoutLocalService
PortalException
public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface LayoutLocalService
getPersistedModel
in interface PersistedModelLocalService
PortalException
public List<Layout> getPublishedLayouts(long groupId, int start, int end, OrderByComparator<Layout> orderByComparator)
getPublishedLayouts
in interface LayoutLocalService
public int getPublishedLayoutsCount(long groupId)
getPublishedLayoutsCount
in interface LayoutLocalService
public List<Layout> getScopeGroupLayouts(long parentGroupId) throws PortalException
getScopeGroupLayouts
in interface LayoutLocalService
PortalException
public List<Layout> getScopeGroupLayouts(long parentGroupId, boolean privateLayout) throws PortalException
getScopeGroupLayouts
in interface LayoutLocalService
parentGroupId
- the primary key of the group's parent groupprivateLayout
- whether the layout is private to the groupPortalException
- if a portal exception occurredpublic boolean hasLayout(String uuid, long groupId, boolean privateLayout) throws PortalException
true
if there is a matching layout with the UUID,
group, and privacy.hasLayout
in interface LayoutLocalService
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 boolean hasLayouts(Group group) throws PortalException
hasLayouts
in interface LayoutLocalService
PortalException
public boolean hasLayouts(Group group, boolean privateLayout) throws PortalException
hasLayouts
in interface LayoutLocalService
PortalException
public boolean hasLayouts(Group group, boolean privateLayout, boolean includeUserGroups) throws PortalException
hasLayouts
in interface LayoutLocalService
PortalException
public boolean hasLayouts(long groupId, boolean privateLayout, long parentLayoutId)
true
if the group has any layouts;
false
otherwise.hasLayouts
in interface LayoutLocalService
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 boolean hasLayouts(User user, boolean privateLayout) throws PortalException
hasLayouts
in interface LayoutLocalService
PortalException
public boolean hasLayouts(User user, boolean privateLayout, boolean includeUserGroups) throws PortalException
hasLayouts
in interface LayoutLocalService
PortalException
public boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, String layoutUuid) throws PortalException
hasLayoutSetPrototypeLayout
in interface LayoutLocalService
PortalException
public boolean hasLayoutSetPrototypeLayout(String layoutSetPrototypeUuid, long companyId, String layoutUuid) throws PortalException
hasLayoutSetPrototypeLayout
in interface LayoutLocalService
PortalException
public List<Layout> search(long groupId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
search
in interface LayoutLocalService
PortalException
public List<Layout> search(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException
search
in interface LayoutLocalService
PortalException
public 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
search
in interface LayoutLocalService
PortalException
public int searchCount(Group group, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) throws PortalException
searchCount
in interface LayoutLocalService
PortalException
public int searchCount(long groupId, long userId, boolean privateLayout, String keywords, boolean searchOnlyByTitle, String[] types) throws PortalException
searchCount
in interface LayoutLocalService
PortalException
public void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext) throws PortalException
setLayouts
in interface LayoutLocalService
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 void updateAsset(long userId, Layout layout, long[] assetCategoryIds, String[] assetTagNames) throws PortalException
updateAsset
in interface LayoutLocalService
PortalException
public Layout updateFriendlyURL(long userId, long plid, String friendlyURL, String languageId) throws PortalException
updateFriendlyURL
in interface LayoutLocalService
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 Layout updateIconImage(long plid, byte[] bytes) throws PortalException
updateIconImage
in interface LayoutLocalService
PortalException
public 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.
updateLayout
in interface LayoutLocalService
layout
- the layoutpublic Layout updateLayout(long groupId, boolean privateLayout, long layoutId, Date publishDate) throws PortalException
updateLayout
in interface LayoutLocalService
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 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long classNameId, long classPK) throws PortalException
updateLayout
in interface LayoutLocalService
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 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
updateLayout
in interface LayoutLocalService
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 Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException
updateLayout
in interface LayoutLocalService
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 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
updateLayout
in interface LayoutLocalService
PortalException
public Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css) throws PortalException
updateLookAndFeel
in interface LayoutLocalService
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 Layout updateMasterLayoutPlid(long groupId, boolean privateLayout, long layoutId, long masterLayoutPlid) throws PortalException
updateMasterLayoutPlid
in interface LayoutLocalService
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 Layout updateName(Layout layout, String name, String languageId) throws PortalException
updateName
in interface LayoutLocalService
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 Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException
updateName
in interface LayoutLocalService
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 Layout updateName(long plid, String name, String languageId) throws PortalException
updateName
in interface LayoutLocalService
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 Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException
updateParentLayoutId
in interface LayoutLocalService
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 Layout updateParentLayoutId(long plid, long parentPlid) throws PortalException
LayoutConstants#DEFAULT_PARENT_LAYOUT_ID
is assigned.updateParentLayoutId
in interface LayoutLocalService
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutPortalException
- if a portal exception occurredpublic Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException
updateParentLayoutIdAndPriority
in interface LayoutLocalService
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic void updatePriorities(long groupId, boolean privateLayout) throws PortalException
updatePriorities
in interface LayoutLocalService
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupPortalException
public Layout updatePriority(Layout layout, int priority) throws PortalException
updatePriority
in interface LayoutLocalService
layout
- the layout to be updatedpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException
updatePriority
in interface LayoutLocalService
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 Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) throws PortalException
updatePriority
in interface LayoutLocalService
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 Layout updatePriority(long plid, int priority) throws PortalException
updatePriority
in interface LayoutLocalService
plid
- the primary key of the layoutpriority
- the layout's new priorityPortalException
- if a portal exception occurredpublic Layout updateStatus(long userId, long plid, int status, ServiceContext serviceContext) throws PortalException
updateStatus
in interface LayoutLocalService
PortalException
public Layout updateStyleBookEntryId(long groupId, boolean privateLayout, long layoutId, long styleBookEntryId) throws PortalException
updateStyleBookEntryId
in interface LayoutLocalService
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 Layout updateType(long plid, String type) throws PortalException
updateType
in interface LayoutLocalService
PortalException
public BasePersistence<?> getBasePersistence()
getBasePersistence
in interface PersistedModelLocalService
public CTPersistence<Layout> getCTPersistence()
getCTPersistence
in interface CTService<Layout>
getCTPersistence
in interface LayoutLocalService
public Class<Layout> getModelClass()
getModelClass
in interface CTService<Layout>
getModelClass
in interface LayoutLocalService
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<Layout>,R,E> updateUnsafeFunction) throws E extends Throwable
updateWithUnsafeFunction
in interface CTService<Layout>
updateWithUnsafeFunction
in interface LayoutLocalService
E extends Throwable
public LayoutLocalService getWrappedService()
getWrappedService
in interface ServiceWrapper<LayoutLocalService>
public void setWrappedService(LayoutLocalService layoutLocalService)
setWrappedService
in interface ServiceWrapper<LayoutLocalService>