com.liferay.portal.kernel.service

Interface LayoutService

All Superinterfaces:

BaseService

All Known Implementing Classes:

LayoutServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LayoutService
extends BaseService

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

LayoutServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
Layout	addLayout(long groupId, boolean privateLayout, long parentLayoutId, long classNameId, long classPK, java.util.Map<java.util.Locale,java.lang.String> localeNamesMap, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, java.lang.String typeSettings, boolean hidden, boolean system, java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap, ServiceContext serviceContext) Adds a layout with additional parameters.
Layout	addLayout(long groupId, boolean privateLayout, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> localeNamesMap, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, java.lang.String typeSettings, boolean hidden, java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap, ServiceContext serviceContext) Adds a layout with additional parameters.
Layout	addLayout(long groupId, boolean privateLayout, long parentLayoutId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, ServiceContext serviceContext) Adds a layout with single entry maps for name, title, and description to the default locale.
FileEntry	addTempFileEntry(long groupId, java.lang.String folderName, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
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.
void	deleteLayout(long plid, ServiceContext serviceContext) Deletes the layout with the plid, also deleting the layout's child layouts, and associated resources.
void	deleteTempFileEntry(long groupId, java.lang.String folderName, java.lang.String fileName)
java.util.List<Layout>	getAncestorLayouts(long plid) Returns all the ancestor layouts of the layout.
long	getControlPanelLayoutPlid() Returns the control panel layout's plid.
long	getDefaultPlid(long groupId, boolean privateLayout) Returns primary key of the matching default layout for the group.
long	getDefaultPlid(long groupId, long scopeGroupId, boolean privateLayout, java.lang.String portletId) Returns the primary key of the default layout for the group.
long	getDefaultPlid(long groupId, long scopeGroupId, java.lang.String portletId)
Layout	getLayoutByUuidAndGroupId(java.lang.String uuid, long groupId, boolean privateLayout) Returns the layout matching the UUID, group, and privacy.
java.lang.String	getLayoutName(long groupId, boolean privateLayout, long layoutId, java.lang.String languageId) Returns the name of the layout.
long	getLayoutPlid(java.lang.String uuid, long groupId, boolean privateLayout) Returns the layout's plid that matches the parameters.
LayoutReference[]	getLayoutReferences(long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.String preferencesValue) Returns the layout references for all the layouts that belong to the company and belong to the portlet that matches the preferences.
java.util.List<Layout>	getLayouts(long groupId, boolean privateLayout)
java.util.List<Layout>	getLayouts(long groupId, boolean privateLayout, long parentLayoutId)
java.util.List<Layout>	getLayouts(long groupId, boolean privateLayout, long parentLayoutId, boolean incomplete, int start, int end)
java.util.List<Layout>	getLayouts(long groupId, java.lang.String type)
java.util.List<Layout>	getLayouts(long groupId, java.lang.String type, int start, int end)
int	getLayoutsCount(long groupId, boolean privateLayout)
int	getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId)
int	getLayoutsCount(long groupId, boolean privateLayout, long parentLayoutId, int priority)
int	getLayoutsCount(long groupId, java.lang.String type)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
java.lang.String[]	getTempFileNames(long groupId, java.lang.String folderName)
boolean	hasLayout(java.lang.String uuid, long groupId, boolean privateLayout) Returns true if there is a matching layout with the UUID, group, and privacy.
boolean	hasPortletId(long plid, java.lang.String portletId)
void	schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String groupName, java.lang.String cronText, java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, java.lang.String description) Schedules a range of layouts to be published.
void	schedulePublishToRemote(long sourceGroupId, boolean privateLayout, java.util.Map<java.lang.Long,java.lang.Boolean> layoutIdMap, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.lang.String remoteAddress, int remotePort, java.lang.String remotePathContext, boolean secureConnection, long remoteGroupId, boolean remotePrivateLayout, java.util.Date startDate, java.util.Date endDate, java.lang.String groupName, java.lang.String cronText, java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, java.lang.String description) Schedules a range of layouts to be stored.
void	setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds, ServiceContext serviceContext) Sets the layouts for the group, replacing and prioritizing all layouts of the parent layout.
void	unschedulePublishToLive(long groupId, java.lang.String jobName, java.lang.String groupName) Deletes the job from the scheduler's queue.
void	unschedulePublishToRemote(long groupId, java.lang.String jobName, java.lang.String groupName) Deletes the job from the scheduler's persistent queue.
Layout	updateIconImage(long plid, byte[] bytes)
Layout	updateLayout(long groupId, boolean privateLayout, long layoutId, long parentLayoutId, java.util.Map<java.util.Locale,java.lang.String> localeNamesMap, java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Map<java.util.Locale,java.lang.String> keywordsMap, java.util.Map<java.util.Locale,java.lang.String> robotsMap, java.lang.String type, boolean hidden, java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap, boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) Updates the layout with additional parameters.
Layout	updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings) Updates the layout replacing its type settings.
Layout	updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css) Updates the look and feel of the layout.
Layout	updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId) Updates the name of the layout matching the group, layout ID, and privacy.
Layout	updateName(long plid, java.lang.String name, java.lang.String languageId) Updates the name of the layout matching the primary key.
Layout	updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId) Updates the parent layout ID of the layout matching the group, layout ID, and privacy.
Layout	updateParentLayoutId(long plid, long parentPlid) Updates the parent layout ID of the layout matching the primary key.
Layout	updateParentLayoutIdAndPriority(long plid, long parentPlid, int priority) Updates the parent layout ID and priority of the layout.
Layout	updatePriority(long groupId, boolean privateLayout, long layoutId, int priority) Updates the priority of the layout matching the group, layout ID, and privacy.
Layout	updatePriority(long groupId, boolean privateLayout, long layoutId, long nextLayoutId, long previousLayoutId) Updates the priority of the layout matching the group, layout ID, and privacy, setting the layout's priority based on the priorities of the next and previous layouts.
Layout	updatePriority(long plid, int priority) Updates the priority of the layout matching the primary key.

Method Detail

addLayout

Layout addLayout(long groupId,
                 boolean privateLayout,
                 long parentLayoutId,
                 long classNameId,
                 long classPK,
                 java.util.Map<java.util.Locale,java.lang.String> localeNamesMap,
                 java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                 java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                 java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
                 java.util.Map<java.util.Locale,java.lang.String> robotsMap,
                 java.lang.String type,
                 java.lang.String typeSettings,
                 boolean hidden,
                 boolean system,
                 java.util.Map<java.util.Locale,java.lang.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)

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

Layout addLayout(long groupId,
                 boolean privateLayout,
                 long parentLayoutId,
                 java.util.Map<java.util.Locale,java.lang.String> localeNamesMap,
                 java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                 java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                 java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
                 java.util.Map<java.util.Locale,java.lang.String> robotsMap,
                 java.lang.String type,
                 java.lang.String typeSettings,
                 boolean hidden,
                 java.util.Map<java.util.Locale,java.lang.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

Layout addLayout(long groupId,
                 boolean privateLayout,
                 long parentLayoutId,
                 java.lang.String name,
                 java.lang.String title,
                 java.lang.String description,
                 java.lang.String type,
                 boolean hidden,
                 java.lang.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

FileEntry addTempFileEntry(long groupId,
                           java.lang.String folderName,
                           java.lang.String fileName,
                           java.io.InputStream inputStream,
                           java.lang.String mimeType)
                    throws PortalException

Throws:

PortalException

deleteLayout

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

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

void deleteTempFileEntry(long groupId,
                         java.lang.String folderName,
                         java.lang.String fileName)
                  throws PortalException

Throws:

PortalException

getAncestorLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getDefaultPlid(long groupId,
                                                                                       long scopeGroupId,
                                                                                       boolean privateLayout,
                                                                                       java.lang.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

@ThreadLocalCachable
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
long getDefaultPlid(long groupId,
                                                                                                             long scopeGroupId,
                                                                                                             java.lang.String portletId)
                                                                                                      throws PortalException

Throws:

PortalException

getLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Layout getLayoutByUuidAndGroupId(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getLayoutName(long groupId,
                                                                                                  boolean privateLayout,
                                                                                                  long layoutId,
                                                                                                  java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getLayoutPlid(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutReference[] getLayoutReferences(long companyId,
                                                                                                         java.lang.String portletId,
                                                                                                         java.lang.String preferencesKey,
                                                                                                         java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Layout> getLayouts(long groupId,
                                                                                                     boolean privateLayout)

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Layout> getLayouts(long groupId,
                                                                                                     boolean privateLayout,
                                                                                                     long parentLayoutId)
                                                                                              throws PortalException

Throws:

PortalException

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Layout> getLayouts(long groupId,
                                                                                                     boolean privateLayout,
                                                                                                     long parentLayoutId,
                                                                                                     boolean incomplete,
                                                                                                     int start,
                                                                                                     int end)
                                                                                              throws PortalException

Throws:

PortalException

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Layout> getLayouts(long groupId,
                                                                                                     java.lang.String type)

getLayouts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Layout> getLayouts(long groupId,
                                                                                                     java.lang.String type,
                                                                                                     int start,
                                                                                                     int end)

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(long groupId,
                                                                                       boolean privateLayout)

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(long groupId,
                                                                                       boolean privateLayout,
                                                                                       long parentLayoutId)

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(long groupId,
                                                                                       boolean privateLayout,
                                                                                       long parentLayoutId,
                                                                                       int priority)

getLayoutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutsCount(long groupId,
                                                                                       java.lang.String type)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getTempFileNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String[] getTempFileNames(long groupId,
                                                                                                       java.lang.String folderName)
                                                                                                throws PortalException

Throws:

PortalException

hasLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasLayout(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasPortletId(long plid,
                                                                                        java.lang.String portletId)
                                                                                 throws PortalException

Throws:

PortalException

schedulePublishToLive

void schedulePublishToLive(long sourceGroupId,
                           long targetGroupId,
                           boolean privateLayout,
                           long[] layoutIds,
                           java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                           java.lang.String groupName,
                           java.lang.String cronText,
                           java.util.Date schedulerStartDate,
                           java.util.Date schedulerEndDate,
                           java.lang.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

void schedulePublishToRemote(long sourceGroupId,
                             boolean privateLayout,
                             java.util.Map<java.lang.Long,java.lang.Boolean> layoutIdMap,
                             java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                             java.lang.String remoteAddress,
                             int remotePort,
                             java.lang.String remotePathContext,
                             boolean secureConnection,
                             long remoteGroupId,
                             boolean remotePrivateLayout,
                             java.util.Date startDate,
                             java.util.Date endDate,
                             java.lang.String groupName,
                             java.lang.String cronText,
                             java.util.Date schedulerStartDate,
                             java.util.Date schedulerEndDate,
                             java.lang.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

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

void unschedulePublishToLive(long groupId,
                             java.lang.String jobName,
                             java.lang.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

void unschedulePublishToRemote(long groupId,
                               java.lang.String jobName,
                               java.lang.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

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

Throws:

PortalException

updateLayout

Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    long parentLayoutId,
                    java.util.Map<java.util.Locale,java.lang.String> localeNamesMap,
                    java.util.Map<java.util.Locale,java.lang.String> localeTitlesMap,
                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                    java.util.Map<java.util.Locale,java.lang.String> keywordsMap,
                    java.util.Map<java.util.Locale,java.lang.String> robotsMap,
                    java.lang.String type,
                    boolean hidden,
                    java.util.Map<java.util.Locale,java.lang.String> friendlyURLMap,
                    boolean iconImage,
                    byte[] iconBytes,
                    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).

iconImage - whether the icon image will be updated

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

Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    java.lang.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

Layout updateLookAndFeel(long groupId,
                         boolean privateLayout,
                         long layoutId,
                         java.lang.String themeId,
                         java.lang.String colorSchemeId,
                         java.lang.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

Layout updateName(long groupId,
                  boolean privateLayout,
                  long layoutId,
                  java.lang.String name,
                  java.lang.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

Layout updateName(long plid,
                  java.lang.String name,
                  java.lang.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

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

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

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

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

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

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