Class LayoutServiceUtil
com.liferay.portal.service.impl.LayoutServiceImpl
and is an
access point for service operations in application layer code running on a
remote server. Methods of this service are expected to have security checks
based on the propagated JAAS credentials because this service can be
accessed remotely.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Layout
addLayout
(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, long classNameId, long classPK, Map<Locale, String> localeNamesMap, Map<Locale, String> localeTitlesMap, Map<Locale, String> descriptionMap, Map<Locale, String> keywordsMap, Map<Locale, String> robotsMap, String type, String typeSettings, boolean hidden, boolean system, Map<Locale, String> friendlyURLMap, long masterLayoutPlid, ServiceContext serviceContext) Adds a layout with additional parameters.static Layout
addLayout
(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) Adds a layout with single entry maps for name, title, and description to the default locale.static Layout
addLayout
(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale, String> localeNamesMap, Map<Locale, String> localeTitlesMap, Map<Locale, String> descriptionMap, Map<Locale, String> keywordsMap, Map<Locale, String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale, String> friendlyURLMap, long masterLayoutPlid, ServiceContext serviceContext) Adds a layout with additional parameters.static Layout
addLayout
(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale, String> localeNamesMap, Map<Locale, String> localeTitlesMap, 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 FileEntry
addTempFileEntry
(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType) static Layout
copyLayout
(long groupId, boolean privateLayout, Map<Locale, String> localeNamesMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) static void
deleteLayout
(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext) Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.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
deleteLayout
(String externalReferenceCode, long groupId) static void
deleteTempFileEntry
(long groupId, String folderName, String fileName) static Layout
fetchFirstLayout
(long groupId, boolean privateLayout, boolean published) static Layout
fetchLayout
(long groupId, boolean privateLayout, long layoutId) static Layout
fetchLayoutByExternalReferenceCode
(String externalReferenceCode, long groupId) static long
fetchLayoutPlid
(String uuid, long groupId, boolean privateLayout) getAncestorLayouts
(long plid) Returns all the ancestor layouts of the layout.static long
Returns the control panel layout's plid.static long
getDefaultPlid
(long groupId, boolean privateLayout) Returns primary key of the matching default layout for the group.static long
getDefaultPlid
(long groupId, long scopeGroupId, boolean privateLayout, String portletId) Returns the primary key of the default layout for the group.static long
getDefaultPlid
(long groupId, long scopeGroupId, String portletId) static Layout
getLayoutByExternalReferenceCode
(String externalReferenceCode, long groupId) static Layout
getLayoutByUuidAndGroupId
(String uuid, long groupId, boolean privateLayout) Returns the layout matching the UUID, group, and privacy.static String
getLayoutName
(long groupId, boolean privateLayout, long layoutId, String languageId) Returns the name of the layout.static long
getLayoutPlid
(String uuid, long groupId, boolean privateLayout) Returns the layout's plid that matches the parameters.static LayoutReference[]
getLayoutReferences
(long companyId, String portletId, String preferencesKey, String preferencesValue) Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.getLayouts
(long groupId, boolean privateLayout) getLayouts
(long groupId, boolean privateLayout, long parentLayoutId) getLayouts
(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end) getLayouts
(long groupId, boolean privateLayout, long parentLayoutId, int start, int end) getLayouts
(long groupId, boolean privateLayout, String type) getLayouts
(long groupId, boolean privateLayout, String type, int start, int end) getLayouts
(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) getLayouts
(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) getLayouts
(long groupId, String type) getLayouts
(long groupId, String type, int start, int end) static int
getLayoutsCount
(long groupId, boolean privateLayout) static int
getLayoutsCount
(long groupId, boolean privateLayout, long parentLayoutId) static int
getLayoutsCount
(long groupId, boolean privateLayout, long parentLayoutId, int priority) static int
getLayoutsCount
(long groupId, boolean privateLayout, String type) static int
getLayoutsCount
(long groupId, boolean privateLayout, String keywords, String[] types) static int
getLayoutsCount
(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses) static int
getLayoutsCount
(long groupId, String type) static String
Returns the OSGi service identifier.static LayoutService
static String[]
getTempFileNames
(long groupId, String folderName) static boolean
Returnstrue
if there is a matching layout with the UUID, group, and privacy.static boolean
hasPortletId
(long plid, String portletId) static Layout
publishLayout
(long plid) static void
schedulePublishToLive
(long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String, String[]> parameterMap, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) Schedules a range of layouts to be published.static void
schedulePublishToRemote
(long sourceGroupId, boolean privateLayout, Map<Long, Boolean> layoutIdMap, Map<String, String[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) Schedules a range of layouts to be stored.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
(LayoutService service) static void
unschedulePublishToLive
(long groupId, String jobName, String groupName) Deletes the job from the scheduler's queue.static void
unschedulePublishToRemote
(long groupId, String jobName, String groupName) Deletes the job from the scheduler's persistent queue.static Layout
updateIconImage
(long plid, byte[] bytes) static Layout
updateLayout
(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale, String> localeNamesMap, Map<Locale, String> localeTitlesMap, 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 with additional parameters.static Layout
updateLayout
(long groupId, boolean privateLayout, long layoutId, String typeSettings) Updates the layout replacing its type settings.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
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 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
updateType
(long plid, String type)
-
Constructor Details
-
LayoutServiceUtil
public LayoutServiceUtil()
-
-
Method Details
-
addLayout
public static Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, long classNameId, long classPK, Map<Locale, String> localeNamesMap, Map<Locale, throws PortalExceptionString> localeTitlesMap, Map<Locale, String> descriptionMap, Map<Locale, String> keywordsMap, Map<Locale, String> robotsMap, String type, String typeSettings, boolean hidden, boolean system, Map<Locale, String> friendlyURLMap, long masterLayoutPlid, ServiceContext serviceContext) Adds a layout with additional parameters.This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
- Parameters:
externalReferenceCode
- the layout's external reference codegroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)classNameId
- the class name ID of the entityclassPK
- the primary key of the entitylocaleNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- the layout's locales and localized titlesdescriptionMap
- the layout's locales and localized descriptionskeywordsMap
- the layout's locales and localized keywordsrobotsMap
- the layout's locales and localized robotstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.typeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.hidden
- whether the layout is hiddensystem
- whether the layout is systemfriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.normalize(String)
.masterLayoutPlid
- the primary key of the master layoutserviceContext
- the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute namedlayoutUpdateable
can be used to specify whether site administrators can modify this page within their site.- Returns:
- the layout
- Throws:
PortalException
- if a portal exception occurred
-
addLayout
public static Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale, String> localeNamesMap, Map<Locale, throws PortalExceptionString> localeTitlesMap, Map<Locale, String> descriptionMap, Map<Locale, String> keywordsMap, Map<Locale, String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale, String> friendlyURLMap, long masterLayoutPlid, ServiceContext serviceContext) Adds a layout with additional parameters.This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
- Parameters:
externalReferenceCode
- the layout's external reference codegroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)localeNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- the layout's locales and localized titlesdescriptionMap
- the layout's locales and localized descriptionskeywordsMap
- the layout's locales and localized keywordsrobotsMap
- the layout's locales and localized robotstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.typeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.hidden
- whether the layout is hiddenfriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.normalize(String)
.masterLayoutPlid
- the primary key of the master layoutserviceContext
- the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute namedlayoutUpdateable
can be used to specify whether site administrators can modify this page within their site.- Returns:
- the layout
- Throws:
PortalException
- if a portal exception occurred
-
addLayout
public static Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, Map<Locale, String> localeNamesMap, Map<Locale, throws PortalExceptionString> localeTitlesMap, Map<Locale, String> descriptionMap, Map<Locale, String> keywordsMap, Map<Locale, String> robotsMap, String type, String typeSettings, boolean hidden, Map<Locale, String> friendlyURLMap, ServiceContext serviceContext) Adds a layout with additional parameters.This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
- Parameters:
externalReferenceCode
- the layout's external reference codegroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)localeNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- the layout's locales and localized titlesdescriptionMap
- the layout's locales and localized descriptionskeywordsMap
- the layout's locales and localized keywordsrobotsMap
- the layout's locales and localized robotstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.typeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.hidden
- whether the layout is hiddenfriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.normalize(String)
.serviceContext
- the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute namedlayoutUpdateable
can be used to specify whether site administrators can modify this page within their site.- Returns:
- the layout
- Throws:
PortalException
- if a portal exception occurred
-
addLayout
public static Layout addLayout(String externalReferenceCode, long groupId, boolean privateLayout, long parentLayoutId, String name, String title, String description, String type, boolean hidden, String friendlyURL, ServiceContext serviceContext) throws PortalException Adds a layout with single entry maps for name, title, and description to the default locale.This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.
- Parameters:
externalReferenceCode
- the layout's external reference codegroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layout (optionallyLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
)name
- the layout's locales and localized namestitle
- the layout's locales and localized titlesdescription
- the layout's locales and localized descriptionstype
- the layout's type (optionallyLayoutConstants#TYPE_PORTLET
). The possible types can be found inLayoutConstants
.hidden
- whether the layout is hiddenfriendlyURL
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, seeFriendlyURLNormalizerUtil.normalize(String)
.serviceContext
- the service context to be applied. Must set the UUID for the layout. Can specify the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute namedlayoutUpdateable
can be used to specify whether site administrators can modify this page within their site.- Returns:
- the layout
- Throws:
PortalException
- if a portal exception occurred
-
addTempFileEntry
public static FileEntry addTempFileEntry(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType) throws PortalException - Throws:
PortalException
-
copyLayout
public static Layout copyLayout(long groupId, boolean privateLayout, Map<Locale, String> localeNamesMap, boolean hidden, boolean system, boolean copyPermissions, long sourcePlid, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
deleteLayout
public static void deleteLayout(long groupId, boolean privateLayout, long layoutId, ServiceContext serviceContext) throws PortalException Deletes the layout with the primary key, also deleting the layout's child layouts, and associated resources.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
deleteLayout
Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.- Parameters:
plid
- the primary key of the layoutserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
deleteLayout
- Throws:
PortalException
-
deleteTempFileEntry
public static void deleteTempFileEntry(long groupId, String folderName, String fileName) throws PortalException - Throws:
PortalException
-
fetchFirstLayout
-
fetchLayout
public static Layout fetchLayout(long groupId, boolean privateLayout, long layoutId) throws PortalException - Throws:
PortalException
-
fetchLayoutByExternalReferenceCode
public static Layout fetchLayoutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
fetchLayoutPlid
public static long fetchLayoutPlid(String uuid, long groupId, boolean privateLayout) throws PortalException - Throws:
PortalException
-
getAncestorLayouts
Returns all the ancestor layouts of the layout.- Parameters:
plid
- the primary key of the layout- Returns:
- the ancestor layouts of the layout
- Throws:
PortalException
- if a portal exception occurred
-
getControlPanelLayoutPlid
Returns the control panel layout's plid.- Returns:
- the control panel layout's plid
- Throws:
PortalException
- if a portal exception is occured
-
getDefaultPlid
public static long getDefaultPlid(long groupId, boolean privateLayout) Returns primary key of the matching default layout for the group.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the primary key of the default layout for the group;
LayoutConstants#DEFAULT_PLID
) otherwise
-
getDefaultPlid
public static long getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, String portletId) throws PortalException Returns the primary key of the default layout for the group.- Parameters:
groupId
- the primary key of the groupscopeGroupId
- the primary key of the scope group. SeeServiceContext.getScopeGroupId()
.privateLayout
- whether the layout is private to the groupportletId
- the primary key of the portlet- Returns:
- Returns the primary key of the default layout group;
LayoutConstants#DEFAULT_PLID
otherwise - Throws:
PortalException
- if a portal exception occurred
-
getDefaultPlid
public static long getDefaultPlid(long groupId, long scopeGroupId, String portletId) throws PortalException - Throws:
PortalException
-
getLayoutByExternalReferenceCode
public static Layout getLayoutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getLayoutByUuidAndGroupId
public static Layout getLayoutByUuidAndGroupId(String uuid, long groupId, boolean privateLayout) throws PortalException Returns the layout matching the UUID, group, and privacy.- Parameters:
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the matching layout
- Throws:
PortalException
- if a portal exception occurred
-
getLayoutName
public static String getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId) throws PortalException Returns the name of the layout.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutlanguageId
- the primary key of the language. For more information SeeLocale
.- Returns:
- the layout's name
- Throws:
PortalException
- if a portal exception occurred
-
getLayoutPlid
public static long getLayoutPlid(String uuid, long groupId, boolean privateLayout) throws PortalException Returns the layout's plid that matches the parameters.- Parameters:
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
- the matching layout's plid
- Throws:
PortalException
- if a portal exception occurred
-
getLayoutReferences
public static LayoutReference[] getLayoutReferences(long companyId, String portletId, String preferencesKey, String preferencesValue) Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.- Parameters:
companyId
- the primary key of the companyportletId
- the primary key of the portletpreferencesKey
- the portlet's preference keypreferencesValue
- the portlet's preference value- Returns:
- the layout references of the matching layouts
-
getLayouts
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId) throws PortalException - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end) throws PortalException - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, long parentLayoutId, int start, int end) throws PortalException - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String type) throws PortalException - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String type, int start, int end) throws PortalException - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException - Throws:
PortalException
-
getLayouts
public static List<Layout> getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses, int start, int end, OrderByComparator<Layout> orderByComparator) throws PortalException - Throws:
PortalException
-
getLayouts
-
getLayouts
-
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout) -
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId) -
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId, int priority) -
getLayoutsCount
-
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout, String keywords, String[] types) throws PortalException - Throws:
PortalException
-
getLayoutsCount
public static int getLayoutsCount(long groupId, boolean privateLayout, String keywords, String[] types, int[] statuses) throws PortalException - Throws:
PortalException
-
getLayoutsCount
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getTempFileNames
- Throws:
PortalException
-
hasLayout
public static boolean hasLayout(String uuid, long groupId, boolean privateLayout) throws PortalException Returnstrue
if there is a matching layout with the UUID, group, and privacy.- Parameters:
uuid
- the layout's UUIDgroupId
- the primary key of the groupprivateLayout
- whether the layout is private to the group- Returns:
true
if the layout is found;false
otherwise- Throws:
PortalException
- if a portal exception occurred
-
hasPortletId
- Throws:
PortalException
-
publishLayout
- Throws:
Exception
-
schedulePublishToLive
public static void schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, Map<String, String[]> parameterMap, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) throws PortalExceptionSchedules a range of layouts to be published.- Parameters:
sourceGroupId
- the primary key of the source grouptargetGroupId
- the primary key of the target groupprivateLayout
- whether the layout is private to the grouplayoutIds
- the layouts considered for publishing, specified by the layout IDsparameterMap
- the mapping of parameters indicating which information will be used. SeePortletDataHandlerKeys
.groupName
- the group name (optionallyDestinationNames#LAYOUTS_LOCAL_PUBLISHER
). SeeDestinationNames
.cronText
- the cron text. SeeCronTextUtil.getCronText(javax.portlet.PortletRequest, java.util.Calendar, boolean, int)
schedulerStartDate
- the scheduler start dateschedulerEndDate
- the scheduler end datedescription
- the scheduler description- Throws:
PortalException
- if a portal exception occurred
-
schedulePublishToRemote
public static void schedulePublishToRemote(long sourceGroupId, boolean privateLayout, Map<Long, Boolean> layoutIdMap, Map<String, throws PortalExceptionString[]> parameterMap, String remoteAddress, int remotePort, String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, Date startDate, Date endDate, String groupName, String cronText, Date schedulerStartDate, Date schedulerEndDate, String description) Schedules a range of layouts to be stored.- Parameters:
sourceGroupId
- the primary key of the source groupprivateLayout
- whether the layout is private to the grouplayoutIdMap
- the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have childrenparameterMap
- the mapping of parameters indicating which information will be used. SeePortletDataHandlerKeys
.remoteAddress
- the remote addressremotePort
- the remote portremotePathContext
- the remote path contextsecureConnection
- whether the connection is secureremoteGroupId
- the primary key of the remote groupremotePrivateLayout
- whether remote group's layout is privatestartDate
- the start dateendDate
- the end dategroupName
- the group name. OptionallyDestinationNames#LAYOUTS_LOCAL_PUBLISHER
). SeeDestinationNames
.cronText
- the cron text. SeeCronTextUtil.getCronText(javax.portlet.PortletRequest, java.util.Calendar, boolean, int)
schedulerStartDate
- the scheduler start dateschedulerEndDate
- the scheduler end datedescription
- the scheduler description- Throws:
PortalException
- if a portal exception occurred
-
setLayouts
public static void setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext) throws PortalException Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the groupparentLayoutId
- the layout ID of the parent layoutlayoutIds
- the primary keys of the layoutsserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
unschedulePublishToLive
public static void unschedulePublishToLive(long groupId, String jobName, String groupName) throws PortalException Deletes the job from the scheduler's queue.- Parameters:
groupId
- the primary key of the groupjobName
- the job namegroupName
- the group name (optionallyDestinationNames#LAYOUTS_LOCAL_PUBLISHER
). SeeDestinationNames
.- Throws:
PortalException
- if a portal exception occurred
-
unschedulePublishToRemote
public static void unschedulePublishToRemote(long groupId, String jobName, String groupName) throws PortalException Deletes the job from the scheduler's persistent queue.- Parameters:
groupId
- the primary key of the groupjobName
- the job namegroupName
- the group name (optionallyDestinationNames#LAYOUTS_LOCAL_PUBLISHER
). SeeDestinationNames
.- Throws:
PortalException
- if a portal exception occurred
-
updateIconImage
- Throws:
PortalException
-
updateLayout
public static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, Map<Locale, String> localeNamesMap, Map<Locale, throws PortalExceptionString> localeTitlesMap, 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 with additional parameters.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutparentLayoutId
- the layout ID of the layout's new parent layoutlocaleNamesMap
- the layout's locales and localized nameslocaleTitlesMap
- the layout's locales and localized titlesdescriptionMap
- the locales and localized descriptions to merge (optionallynull
)keywordsMap
- the locales and localized keywords to merge (optionallynull
)robotsMap
- the locales and localized robots to merge (optionallynull
)type
- the layout's new type (optionallyLayoutConstants#TYPE_PORTLET
)hidden
- whether the layout is hiddenfriendlyURLMap
- the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed seeFriendlyURLNormalizerUtil.normalize(String)
.hasIconImage
- if the layout has a custom icon imageiconBytes
- the byte array of the layout's new icon imagestyleBookEntryId
- the primary key of the style book entryfaviconFileEntryId
- 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.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateLayout
public static Layout updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) throws PortalException Updates the layout replacing its type settings.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layouttypeSettings
- the settings to load the unicode properties object. See#fastLoad(String)
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateLookAndFeel
public static Layout updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css) throws PortalException Updates the look and feel of the layout.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutthemeId
- the primary key of the layout's new themecolorSchemeId
- the primary key of the layout's new color schemecss
- the layout's new CSS- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateName
public static Layout updateName(long groupId, boolean privateLayout, long layoutId, String name, String languageId) throws PortalException Updates the name of the layout matching the group, layout ID, and privacy.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutname
- the layout's new namelanguageId
- the primary key of the language. For more information seeLocale
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateName
Updates the name of the layout matching the primary key.- Parameters:
plid
- the primary key of the layoutname
- the name to be assignedlanguageId
- the primary key of the language. For more information seeLocale
.- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateParentLayoutId
public static Layout updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) throws PortalException Updates the parent layout ID of the layout matching the group, layout ID, and privacy.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutparentLayoutId
- the layout ID to be assigned to the parent layout- Returns:
- the matching layout
- Throws:
PortalException
- if a portal exception occurred
-
updateParentLayoutId
Updates the parent layout ID of the layout matching the primary key. If a layout matching the parent primary key is found, the layout ID of that layout is assigned, otherwiseLayoutConstants#DEFAULT_PARENT_LAYOUT_ID
is assigned.- Parameters:
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layout- Returns:
- the layout matching the primary key
- Throws:
PortalException
- if a portal exception occurred
-
updateParentLayoutIdAndPriority
public static Layout updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) throws PortalException Updates the parent layout ID and priority of the layout.- Parameters:
plid
- the primary key of the layoutparentPlid
- the primary key of the parent layoutpriority
- the layout's new priority- Returns:
- the layout matching the primary key
- Throws:
PortalException
- if a portal exception occurred
-
updatePriority
public static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) throws PortalException Updates the priority of the layout matching the group, layout ID, and privacy.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutpriority
- the layout's new priority- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updatePriority
public static Layout updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) throws PortalException Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.- Parameters:
groupId
- the primary key of the groupprivateLayout
- whether the layout is private to the grouplayoutId
- the layout ID of the layoutnextLayoutId
- the layout ID of the next layoutpreviousLayoutId
- the layout ID of the previous layout- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updatePriority
Updates the priority of the layout matching the primary key.- Parameters:
plid
- the primary key of the layoutpriority
- the layout's new priority- Returns:
- the updated layout
- Throws:
PortalException
- if a portal exception occurred
-
updateType
- Throws:
PortalException
-
getService
-
setService
-