com.liferay.portal.kernel.service

Class LayoutServiceUtil

Object

com.liferay.portal.kernel.service.LayoutServiceUtil

public class LayoutServiceUtil
extends Object

Provides the remote service utility for Layout. This utility wraps 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:

LayoutService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
LayoutServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Layout	addLayout(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, long masterLayoutPlid, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext) Deprecated. As of Mueller (7.2.x), replaced by addLayout(long, boolean, long, long, long, Map, Map, Map, Map, Map, String, String, boolean, boolean, Map, long, ServiceContext)
static Layout	addLayout(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(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, ServiceContext serviceContext) Deprecated. As of Mueller (7.2.x), replaced by addLayout(long, boolean, long, long, long, Map, Map, Map, Map, Map, String, String, boolean, boolean, long, Map, ServiceContext)
static Layout	addLayout(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, long masterLayoutPlid, Map<Locale,String> friendlyURLMap, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by addLayout(long, boolean, long, long, long, Map, Map, Map, Map, Map, String, String, boolean, boolean, Map, long, ServiceContext)
static Layout	addLayout(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(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 Layout	addLayout(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 FileEntry	addTempFileEntry(long groupId, String folderName, String fileName, InputStream inputStream, String mimeType)
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	deleteTempFileEntry(long groupId, String folderName, String fileName)
static Layout	fetchLayout(long groupId, boolean privateLayout, long layoutId)
static List<Layout>	getAncestorLayouts(long plid) Returns all the ancestor layouts of the layout.
static long	getControlPanelLayoutPlid() 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	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.
static List<Layout>	getLayouts(long groupId, boolean privateLayout)
static List<Layout>	getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
static List<Layout>	getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)
static List<Layout>	getLayouts(long groupId, boolean privateLayout, String type)
static List<Layout>	getLayouts(long groupId, boolean privateLayout, String type, int start, int end)
static List<Layout>	getLayouts(long groupId, boolean privateLayout, String keywords, String[] types, int start, int end, OrderByComparator<Layout> orderByComparator)
static List<Layout>	getLayouts(long groupId, String type)
static List<Layout>	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, String type)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static LayoutService	getService()
static String[]	getTempFileNames(long groupId, String folderName)
static boolean	hasLayout(String uuid, long groupId, boolean privateLayout) Returns true if there is a matching layout with the UUID, group, and privacy.
static boolean	hasPortletId(long plid, String portletId)
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	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 masterLayoutPlid, long styleBookEntryId, ServiceContext serviceContext) Updates the layout with additional parameters.
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 masterLayoutPlid, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, boolean, byte[], long, long, ServiceContext)
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, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, boolean, byte[], long, ServiceContext)
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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutServiceUtil

public LayoutServiceUtil()

Method Detail

addLayout

@Deprecated
public static Layout addLayout(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,
                                           long masterLayoutPlid,
                                           Map<Locale,String> friendlyURLMap,
                                           ServiceContext serviceContext)
                                    throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by addLayout(long, boolean, long, long, long, Map, Map, Map, Map, Map, String, String, boolean, boolean, Map, long, 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:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

classNameId - the class name ID of the entity

classPK - the primary key of the entity

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

hidden - whether the layout is hidden

system - whether the layout is system

masterLayoutPlid - the primary key of the master layout

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).

serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be 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(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)
                        throws PortalException

Adds a layout with additional parameters.

This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

classNameId - the class name ID of the entity

classPK - the primary key of the entity

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

hidden - whether the layout is hidden

system - whether the layout is system

friendlyURLMap - 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 layout

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 used to specify whether site administrators can modify this page within their site.

Returns:

the layout

Throws:

PortalException - if a portal exception occurred

addLayout

@Deprecated
public static Layout addLayout(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,
                                           ServiceContext serviceContext)
                                    throws PortalException

Deprecated. As of Mueller (7.2.x), replaced by addLayout(long, boolean, long, long, long, Map, Map, Map, Map, Map, String, String, boolean, boolean, long, Map, 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:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

classNameId - the class name ID of the entity

classPK - the primary key of the entity

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

hidden - whether the layout is hidden

system - whether the layout is system

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).

serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be used to specify whether site administrators can modify this page within their site.

Returns:

the layout

Throws:

PortalException - if a portal exception occurred

addLayout

@Deprecated
public static Layout addLayout(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,
                                           long masterLayoutPlid,
                                           Map<Locale,String> friendlyURLMap,
                                           ServiceContext serviceContext)
                                    throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by addLayout(long, boolean, long, long, long, Map, Map, Map, Map, Map, String, String, boolean, boolean, Map, long, 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:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

hidden - whether the layout is hidden

masterLayoutPlid - the primary key of the master layout

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).

serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be 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(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)
                        throws PortalException

Adds a layout with additional parameters.

This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

hidden - whether the layout is hidden

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).

masterLayoutPlid - the primary key of the master layout

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 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(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)
                        throws PortalException

Adds a layout with additional parameters.

This method handles the creation of the layout including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to any methods to setup default groups, resources, ... etc.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the layout's locales and localized descriptions

keywordsMap - the layout's locales and localized keywords

robotsMap - the layout's locales and localized robots

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

hidden - whether the layout is hidden

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed, see FriendlyURLNormalizerUtil.normalize( String).

serviceContext - the service context to be applied. Must set the UUID for the layout. Can set the creation date, modification date, and expando bridge attributes for the layout. For layouts that belong to a layout set prototype, an attribute named layoutUpdateable can be 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(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:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout (optionally LayoutConstants#DEFAULT_PARENT_LAYOUT_ID)

name - the layout's locales and localized names

title - the layout's locales and localized titles

description - the layout's locales and localized descriptions

type - the layout's type (optionally LayoutConstants#TYPE_PORTLET). The possible types can be found in LayoutConstants.

hidden - whether the layout is hidden

friendlyURL - the 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 specify 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 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

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

serviceContext - the service context to be applied

Throws:

PortalException - if a portal exception occurred

deleteLayout

public static void deleteLayout(long plid,
                                ServiceContext serviceContext)
                         throws PortalException

Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.

Parameters:

plid - the primary key of the layout

serviceContext - the service context to be applied

Throws:

PortalException - if a portal exception occurred

deleteTempFileEntry

public static void deleteTempFileEntry(long groupId,
                                       String folderName,
                                       String fileName)
                                throws PortalException

Throws:

PortalException

fetchLayout

public static Layout fetchLayout(long groupId,
                                 boolean privateLayout,
                                 long layoutId)
                          throws PortalException

Throws:

PortalException

getAncestorLayouts

public static List<Layout> getAncestorLayouts(long plid)
                                       throws PortalException

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

public static long getControlPanelLayoutPlid()
                                      throws PortalException

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 group

privateLayout - whether the layout is private to the group

Returns:

the primary key of the default layout for the group; LayoutConstants#DEFAULT_PLID) otherwise

getDefaultPlid

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 group

scopeGroupId - the primary key of the scope group. See ServiceContext.getScopeGroupId().

privateLayout - whether the layout is private to the group

portletId - 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

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 UUID

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

Returns:

the matching layout

Throws:

PortalException - if a 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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

languageId - the primary key of the language. For more information See Locale.

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 UUID

groupId - the primary key of the group

privateLayout - 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 company

portletId - the primary key of the portlet

preferencesKey - the portlet's preference key

preferencesValue - the portlet's preference value

Returns:

the layout references of the matching layouts

getLayouts

public static List<Layout> getLayouts(long groupId,
                                      boolean privateLayout)

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,
                                      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,
                                      String type)

getLayouts

public static List<Layout> getLayouts(long groupId,
                                      String type,
                                      int start,
                                      int end)

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

public static int getLayoutsCount(long groupId,
                                  boolean privateLayout,
                                  String type)

getLayoutsCount

public static int getLayoutsCount(long groupId,
                                  boolean privateLayout,
                                  String keywords,
                                  String[] types)
                           throws PortalException

Throws:

PortalException

getLayoutsCount

public static int getLayoutsCount(long groupId,
                                  String type)

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getTempFileNames

public static String[] getTempFileNames(long groupId,
                                        String folderName)
                                 throws PortalException

Throws:

PortalException

hasLayout

public static boolean hasLayout(String uuid,
                                long groupId,
                                boolean privateLayout)
                         throws PortalException

Returns true if there is a matching layout with the UUID, group, and privacy.

Parameters:

uuid - the layout's UUID

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

Returns:

true if the layout is found; false otherwise

Throws:

PortalException - if a portal exception occurred

hasPortletId

public static boolean hasPortletId(long plid,
                                   String portletId)
                            throws PortalException

Throws:

PortalException

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 PortalException

Schedules a range of layouts to be published.

Parameters:

sourceGroupId - the primary key of the source group

targetGroupId - the primary key of the target group

privateLayout - whether the layout is private to the group

layoutIds - the layouts considered for publishing, specified by the layout IDs

parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.

groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

cronText - the cron text. See #toCronText

schedulerStartDate - the scheduler start date

schedulerEndDate - the scheduler end date

description - 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,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)
                                    throws PortalException

Schedules a range of layouts to be stored.

Parameters:

sourceGroupId - the primary key of the source group

privateLayout - whether the layout is private to the group

layoutIdMap - the layouts considered for publishing, specified by the layout IDs and booleans indicating whether they have children

parameterMap - the mapping of parameters indicating which information will be used. See PortletDataHandlerKeys.

remoteAddress - the remote address

remotePort - the remote port

remotePathContext - the remote path context

secureConnection - whether the connection is secure

remoteGroupId - the primary key of the remote group

remotePrivateLayout - whether remote group's layout is private

startDate - the start date

endDate - the end date

groupName - the group name. Optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

cronText - the cron text. See #toCronText

schedulerStartDate - the scheduler start date

schedulerEndDate - the scheduler end date

description - 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 group

privateLayout - whether the layout is private to the group

parentLayoutId - the layout ID of the parent layout

layoutIds - the primary keys of the layouts

serviceContext - 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 group

jobName - the job name

groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

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 group

jobName - the job name

groupName - the group name (optionally DestinationNames#LAYOUTS_LOCAL_PUBLISHER). See DestinationNames.

Throws:

PortalException - if a portal exception occurred

updateIconImage

public static Layout updateIconImage(long plid,
                                     byte[] bytes)
                              throws PortalException

Throws:

PortalException

updateLayout

public 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 masterLayoutPlid,
                                  long styleBookEntryId,
                                  ServiceContext serviceContext)
                           throws PortalException

Updates the layout with additional parameters.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

parentLayoutId - the layout ID of the layout's new parent layout

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the locales and localized descriptions to merge (optionally null)

keywordsMap - the locales and localized keywords to merge (optionally null)

robotsMap - the locales and localized robots to merge (optionally null)

type - the layout's new type (optionally LayoutConstants#TYPE_PORTLET)

hidden - whether the layout is hidden

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).

hasIconImage - if the layout has a custom icon image

iconBytes - the byte array of the layout's new icon image

masterLayoutPlid - the primary key of the master layout

styleBookEntryId - the primary key of the style book entry

serviceContext - 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

@Deprecated
public 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 masterLayoutPlid,
                                              ServiceContext serviceContext)
                                       throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, boolean, byte[], long, long, ServiceContext)

Updates the layout with additional parameters.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

parentLayoutId - the layout ID of the layout's new parent layout

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the locales and localized descriptions to merge (optionally null)

keywordsMap - the locales and localized keywords to merge (optionally null)

robotsMap - the locales and localized robots to merge (optionally null)

type - the layout's new type (optionally LayoutConstants#TYPE_PORTLET)

hidden - whether the layout is hidden

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).

hasIconImage - if the layout has a custom icon image

iconBytes - the byte array of the layout's new icon image

masterLayoutPlid - the primary key of the master layout

serviceContext - 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

@Deprecated
public 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,
                                              ServiceContext serviceContext)
                                       throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by updateLayout(long, boolean, long, long, Map, Map, Map, Map, Map, String, boolean, Map, boolean, byte[], long, ServiceContext)

Updates the layout with additional parameters.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

parentLayoutId - the layout ID of the layout's new parent layout

localeNamesMap - the layout's locales and localized names

localeTitlesMap - the layout's locales and localized titles

descriptionMap - the locales and localized descriptions to merge (optionally null)

keywordsMap - the locales and localized keywords to merge (optionally null)

robotsMap - the locales and localized robots to merge (optionally null)

type - the layout's new type (optionally LayoutConstants#TYPE_PORTLET)

hidden - whether the layout is hidden

friendlyURLMap - the layout's locales and localized friendly URLs. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).

hasIconImage - if the layout has a custom icon image

iconBytes - the byte array of the layout's new icon image

serviceContext - the service context to be applied. Can set the modification date and expando bridge attributes for the layout.

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

typeSettings - the settings to load the unicode properties object. See #fastLoad(String).

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateLookAndFeel

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

themeId - the primary key of the layout's new theme

colorSchemeId - the primary key of the layout's new color scheme

css - the layout's new CSS

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateName

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

name - the layout's new name

languageId - the primary key of the language. For more information see Locale.

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateName

public static Layout updateName(long plid,
                                String name,
                                String languageId)
                         throws PortalException

Updates the name of the layout matching the primary key.

Parameters:

plid - the primary key of the layout

name - the name to be assigned

languageId - the primary key of the language. For more information see Locale.

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateParentLayoutId

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

parentLayoutId - the layout ID to be assigned to the parent layout

Returns:

the matching layout

Throws:

PortalException - if a portal exception occurred

updateParentLayoutId

public static Layout updateParentLayoutId(long plid,
                                          long parentPlid)
                                   throws PortalException

Updates the parent layout ID of the layout matching the primary key. If a layout matching the parent primary key is found, the layout ID of that layout is assigned, otherwise LayoutConstants#DEFAULT_PARENT_LAYOUT_ID is assigned.

Parameters:

plid - the primary key of the layout

parentPlid - the primary key of the parent layout

Returns:

the layout matching the primary key

Throws:

PortalException - if a portal exception occurred

updateParentLayoutIdAndPriority

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 layout

parentPlid - the primary key of the parent layout

priority - the layout's new priority

Returns:

the layout matching the primary key

Throws:

PortalException - if a portal exception occurred

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

priority - the layout's new priority

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updatePriority

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 group

privateLayout - whether the layout is private to the group

layoutId - the layout ID of the layout

nextLayoutId - the layout ID of the next layout

previousLayoutId - the layout ID of the previous layout

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updatePriority

public static Layout updatePriority(long plid,
                                    int priority)
                             throws PortalException

Updates the priority of the layout matching the primary key.

Parameters:

plid - the primary key of the layout

priority - the layout's new priority

Returns:

the updated layout

Throws:

PortalException - if a portal exception occurred

updateType

public static Layout updateType(long plid,
                                String type)
                         throws PortalException

Throws:

PortalException

getService

public static LayoutService getService()