com.liferay.portal.service
Class LayoutServiceUtil

java.lang.Object
  com.liferay.portal.service.LayoutServiceUtil

public class LayoutServiceUtil
extends Object

The utility for the layout remote service. This utility wraps LayoutServiceImpl and is the primary access point for service operations in application layer code running on a remote server.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

LayoutService, LayoutServiceBaseImpl, LayoutServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

LayoutServiceUtil()

Method Summary

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, boolean hidden, String friendlyURL, 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) This method handles the creation of the layout including its resources, metadata, and internal data structures.
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 byte[]	exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate) Exports the layouts that match the primary keys and the criteria as a byte array.
static byte[]	exportLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, Date startDate, Date endDate) Exports all layouts that match the criteria as a byte array.
static File	exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, Map<String,String[]> parameterMap, Date startDate, Date endDate) Exports all layouts that match the primary keys and criteria as a file.
static byte[]	exportPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) Exports the portlet information (categories, permissions, ... etc.) as a byte array.
static File	exportPortletInfoAsFile(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, Date startDate, Date endDate) Exports the portlet information (categories, permissions, ... etc.) as a file.
static List<Layout>	getAncestorLayouts(long plid) Returns all the ancestor layouts of the layout.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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)
static String	getLayoutName(long groupId, boolean privateLayout, long layoutId, String languageId) Returns the name of the layout.
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 LayoutService	getService()
static void	importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, byte[] bytes) Imports the layouts from the byte array.
static void	importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, File file) Imports the layouts from the file.
static void	importLayouts(long groupId, boolean privateLayout, Map<String,String[]> parameterMap, InputStream is) Imports the layouts from the input stream.
static void	importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, File file) Imports the portlet information (categories, permissions, ... etc.) from the file.
static void	importPortletInfo(long plid, long groupId, String portletId, Map<String,String[]> parameterMap, InputStream is) Imports the portlet information (categories, permissions, ... etc.) from the input stream.
static void	schedulePublishToLive(long sourceGroupId, long targetGroupId, boolean privateLayout, Map<Long,Boolean> layoutIdMap, Map<String,String[]> parameterMap, String scope, Date startDate, Date endDate, 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	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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.
void	setService(LayoutService service) Deprecated.
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	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, String friendlyURL, Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext) Updates the layout.
static Layout	updateLayout(long groupId, boolean privateLayout, long layoutId, String typeSettings) Updates the layout replacing its type settings.
static Layout	updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, String themeId, String colorSchemeId, String css, boolean wapTheme) 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	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 plid, int priority) Updates the priority of the layout matching the primary key.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutServiceUtil

public LayoutServiceUtil()

Method Detail

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

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,
                               boolean hidden,
                               String friendlyURL,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

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 primary key 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.

hidden - whether the layout is hidden

friendlyURL - the layout's friendly URL (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues.DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).

serviceContext - the service context. Must set the universally unique identifier (UUID) for the layout. Can set the creation date, modification date and the 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 group with the primary key could not be found, if the group did not have permission to manage the layouts involved, or if layout values were invalid

SystemException - if a system 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,
                               SystemException

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 primary key of the parent layout (optionally LayoutConstants.DEFAULT_PARENT_LAYOUT_ID)

name - Map the layout's locales and localized names

title - Map the layout's locales and localized titles

description - Map 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 friendly URL (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues.DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).

serviceContext - the service context. Must set the universally unique identifier (UUID) for the layout. Can specify the creation date, modification date and the 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 group with the primary key could not be found, if the group did not have permission to manage the layouts involved, or if layout values were invalid

SystemException - if a system exception occurred

deleteLayout

public static void deleteLayout(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

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 primary key of the layout

serviceContext - the service context

Throws:

PortalException - if the user did not have permission to delete the layout, if a matching layout could not be found , or if some other portal exception occurred

SystemException - if a system exception occurred

deleteLayout

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

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

Throws:

PortalException - if the user did not have permission to delete the layout, if a layout with the primary key could not be found , or if some other portal exception occurred

SystemException - if a system exception occurred

exportLayouts

public static byte[] exportLayouts(long groupId,
                                   boolean privateLayout,
                                   long[] layoutIds,
                                   Map<String,String[]> parameterMap,
                                   Date startDate,
                                   Date endDate)
                            throws PortalException,
                                   SystemException

Exports the layouts that match the primary keys and the criteria as a byte array.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutIds - the primary keys of the layouts to be exported

parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.

startDate - the export's start date

endDate - the export's end date

Returns:

the layouts as a byte array

Throws:

PortalException - if a group or any layout with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred

SystemException - if a system exception occurred

exportLayouts

public static byte[] exportLayouts(long groupId,
                                   boolean privateLayout,
                                   Map<String,String[]> parameterMap,
                                   Date startDate,
                                   Date endDate)
                            throws PortalException,
                                   SystemException

Exports all layouts that match the criteria as a byte array.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.

startDate - the export's start date

endDate - the export's end date

Returns:

the layout as a byte array

Throws:

PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred

SystemException - if a system exception occurred

exportLayoutsAsFile

public static File exportLayoutsAsFile(long groupId,
                                       boolean privateLayout,
                                       long[] layoutIds,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException

Exports all layouts that match the primary keys and criteria as a file.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutIds - the primary keys of the layouts to be exported (optionally null)

parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.

startDate - the export's start date

endDate - the export's end date

Returns:

the layouts as a File

Throws:

PortalException - if a group or any layout with the primary key could not be found, it the group did not have permission to manage the layouts, or if some other portal exception occurred

SystemException - if a system exception occurred

exportPortletInfo

public static byte[] exportPortletInfo(long plid,
                                       long groupId,
                                       String portletId,
                                       Map<String,String[]> parameterMap,
                                       Date startDate,
                                       Date endDate)
                                throws PortalException,
                                       SystemException

Exports the portlet information (categories, permissions, ... etc.) as a byte array.

Parameters:

plid - the primary key of the layout

groupId - the primary key of the group

portletId - the primary key of the portlet

parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.

startDate - the export's start date

endDate - the export's end date

Returns:

the portlet information as a byte array

Throws:

PortalException - if a layout, group, or portlet with the primary key could not be found, if the group did not have permission to manage the layouts involved, or if some other portal exception occurred

SystemException - if a system exception occurred

exportPortletInfoAsFile

public static File exportPortletInfoAsFile(long plid,
                                           long groupId,
                                           String portletId,
                                           Map<String,String[]> parameterMap,
                                           Date startDate,
                                           Date endDate)
                                    throws PortalException,
                                           SystemException

Exports the portlet information (categories, permissions, ... etc.) as a file.

Parameters:

plid - the primary key of the layout

groupId - the primary key of the group

portletId - the primary key of the portlet

parameterMap - the mapping of parameters indicating which information to export. For information on the keys used in the map see PortletDataHandlerKeys.

startDate - the export's start date

endDate - the export's end date

Returns:

the portlet information as a file

Throws:

PortalException - if a layout, group, or portlet with the primary key could not be found, it the group did not have permission to manage the layouts involved, or if some other portal exception occurred

SystemException - if a system exception occurred

getAncestorLayouts

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

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 matching layout could not be found or if a portal exception occurred

SystemException - if a system exception occurred

getDefaultPlid

public static long getDefaultPlid(long groupId,
                                  long scopeGroupId,
                                  boolean privateLayout,
                                  String portletId)
                           throws PortalException,
                                  SystemException

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 group, layout, or portlet with the primary key could not be found

SystemException - if a system exception occurred

getDefaultPlid

public static long getDefaultPlid(long groupId,
                                  long scopeGroupId,
                                  String portletId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getLayoutByUuidAndGroupId

public static Layout getLayoutByUuidAndGroupId(String uuid,
                                               long groupId,
                                               boolean privateLayout)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getLayoutName

public static String getLayoutName(long groupId,
                                   boolean privateLayout,
                                   long layoutId,
                                   String languageId)
                            throws PortalException,
                                   SystemException

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 primary key of the layout

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

Returns:

the layout's name

Throws:

PortalException - if a matching layout could not be found

SystemException - if a system exception occurred

getLayoutReferences

public static LayoutReference[] getLayoutReferences(long companyId,
                                                    String portletId,
                                                    String preferencesKey,
                                                    String preferencesValue)
                                             throws SystemException

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

Throws:

SystemException - if a system exception occurred

getLayouts

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

Throws:

SystemException

getLayouts

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

Throws:

SystemException

getLayouts

public static List<Layout> getLayouts(long groupId,
                                      boolean privateLayout,
                                      long parentLayoutId,
                                      boolean incomplete,
                                      int start,
                                      int end)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

importLayouts

public static void importLayouts(long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 byte[] bytes)
                          throws PortalException,
                                 SystemException

Imports the layouts from the byte array.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.

bytes - the byte array with the data

Throws:

PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred

SystemException - if a system exception occurred

See Also:

LayoutImporter

importLayouts

public static void importLayouts(long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 File file)
                          throws PortalException,
                                 SystemException

Imports the layouts from the file.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.

file - the LAR file with the data

Throws:

PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts and publish, or if some other portal exception occurred

SystemException - if a system exception occurred

See Also:

LayoutImporter

importLayouts

public static void importLayouts(long groupId,
                                 boolean privateLayout,
                                 Map<String,String[]> parameterMap,
                                 InputStream is)
                          throws PortalException,
                                 SystemException

Imports the layouts from the input stream.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.

is - the input stream

Throws:

PortalException - if a group with the primary key could not be found, if the group did not have permission to manage the layouts, or if some other portal exception occurred

SystemException - if a system exception occurred

See Also:

LayoutImporter

importPortletInfo

public static void importPortletInfo(long plid,
                                     long groupId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     File file)
                              throws PortalException,
                                     SystemException

Imports the portlet information (categories, permissions, ... etc.) from the file.

Parameters:

plid - the primary key of the layout

groupId - the primary key of the group

portletId - the primary key of the portlet

parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.

file - the LAR file with the data

Throws:

PortalException - if a group, layout, or portlet with the primary key could not be found, or if the group did not have permission to manage the layouts

SystemException - if a system exception occurred

importPortletInfo

public static void importPortletInfo(long plid,
                                     long groupId,
                                     String portletId,
                                     Map<String,String[]> parameterMap,
                                     InputStream is)
                              throws PortalException,
                                     SystemException

Imports the portlet information (categories, permissions, ... etc.) from the input stream.

Parameters:

plid - the primary key of the layout

groupId - the primary key of the group

portletId - the primary key of the portlet

parameterMap - the mapping of parameters indicating which information will be imported. For information on the keys used in the map see PortletDataHandlerKeys.

is - the input stream

Throws:

PortalException - if a group, portlet, or layout with the primary key could not be found or if the group did not have permission to manage the layouts

SystemException - if a system exception occurred

schedulePublishToLive

public static void schedulePublishToLive(long sourceGroupId,
                                         long targetGroupId,
                                         boolean privateLayout,
                                         Map<Long,Boolean> layoutIdMap,
                                         Map<String,String[]> parameterMap,
                                         String scope,
                                         Date startDate,
                                         Date endDate,
                                         String groupName,
                                         String cronText,
                                         Date schedulerStartDate,
                                         Date schedulerEndDate,
                                         String description)
                                  throws PortalException,
                                         SystemException

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

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

scope - the scope of the pages. It can be all-pages or selected-pages.

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 the group did not have permission to manage and publish

SystemException - if a system 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,
                                           SystemException

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 group with the source group primary key was not found or if the group did not have permission to publish

SystemException - if a system exception occurred

setLayouts

public static void setLayouts(long groupId,
                              boolean privateLayout,
                              long parentLayoutId,
                              long[] layoutIds,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException

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 primary key of the parent layout

layoutIds - the primary keys of the layouts

serviceContext - the service context

Throws:

PortalException - if a group or layout with the primary key could not be found, if the group did not have permission to manage the layouts, if no layouts were specified, if the first layout was not page-able, if the first layout was hidden, or if some other portal exception occurred

SystemException - if a system exception occurred

unschedulePublishToLive

public static void unschedulePublishToLive(long groupId,
                                           String jobName,
                                           String groupName)
                                    throws PortalException,
                                           SystemException

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 the group did not permission to manage staging and publish

SystemException - if a system exception occurred

unschedulePublishToRemote

public static void unschedulePublishToRemote(long groupId,
                                             String jobName,
                                             String groupName)
                                      throws PortalException,
                                             SystemException

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 group with the primary key could not be found or if the group did not have permission to publish

SystemException - if a system exception occurred

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,
                                  String friendlyURL,
                                  Boolean iconImage,
                                  byte[] iconBytes,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Updates the layout.

Parameters:

groupId - the primary key of the group

privateLayout - whether the layout is private to the group

layoutId - the primary key of the layout

parentLayoutId - the primary key 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

friendlyURL - the layout's new friendly URL (optionally PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL or PropsValues.DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL). The default values can be overridden in portal-ext.properties by specifying new values for the corresponding properties defined in PropsValues. To see how the URL is normalized when accessed see FriendlyURLNormalizerUtil.normalize( String).

iconImage - whether the icon image will be updated

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

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

Returns:

the updated layout

Throws:

PortalException - if a group or layout with the primary key could not be found, if the user did not have permission to update the layout, if a unique friendly URL could not be generated, if a valid parent layout ID to use could not be found, or if the layout parameters were invalid

SystemException - if a system exception occurred

updateLayout

public static Layout updateLayout(long groupId,
                                  boolean privateLayout,
                                  long layoutId,
                                  String typeSettings)
                           throws PortalException,
                                  SystemException

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 primary key of the layout

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

Returns:

the updated layout

Throws:

PortalException - if a matching layout could not be found or if the user did not have permission to update the layout

SystemException - if a system exception occurred

updateLookAndFeel

public static Layout updateLookAndFeel(long groupId,
                                       boolean privateLayout,
                                       long layoutId,
                                       String themeId,
                                       String colorSchemeId,
                                       String css,
                                       boolean wapTheme)
                                throws PortalException,
                                       SystemException

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 primary key 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

wapTheme - whether the theme is for WAP browsers

Returns:

the updated layout

Throws:

PortalException - if a matching layout could not be found, or if the user did not have permission to update the layout and permission to apply the theme

SystemException - if a system exception occurred

updateName

public static Layout updateName(long groupId,
                                boolean privateLayout,
                                long layoutId,
                                String name,
                                String languageId)
                         throws PortalException,
                                SystemException

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 primary key 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 matching layout could not be found, if the user did not have permission to update the layout, or if the new name was null

SystemException - if a system exception occurred

updateName

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

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 layout with the primary key could not be found, or if the user did not have permission to update the layout, or if the name was null

SystemException - if a system exception occurred

updateParentLayoutId

public static Layout updateParentLayoutId(long groupId,
                                          boolean privateLayout,
                                          long layoutId,
                                          long parentLayoutId)
                                   throws PortalException,
                                          SystemException

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 primary key of the layout

parentLayoutId - the primary key to be assigned to the parent layout

Returns:

the matching layout

Throws:

PortalException - if a valid parent layout ID to use could not be found, if a matching layout could not be found, or if the user did not have permission to update the layout

SystemException - if a system exception occurred

updateParentLayoutId

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

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 layout with the primary key could not be found, if the user did not have permission to update the layout, or if a valid parent layout ID to use could not be found

SystemException - if a system exception occurred

updatePriority

public static Layout updatePriority(long groupId,
                                    boolean privateLayout,
                                    long layoutId,
                                    int priority)
                             throws PortalException,
                                    SystemException

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 primary key of the layout

priority - the layout's new priority

Returns:

the updated layout

Throws:

PortalException - if a matching layout could not be found or if the user did not have permission to update the layout

SystemException - if a system exception occurred

updatePriority

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

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 layout with the primary key could not be found

SystemException - if a system exception occurred

getService

public static LayoutService getService()

setService

public void setService(LayoutService service)

Deprecated.