com.liferay.portal.service
Class LayoutServiceUtil

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

public class LayoutServiceUtil
extends java.lang.Object

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

Never modify this class directly. Add custom service methods to com.liferay.portal.service.impl.LayoutServiceImpl and rerun ServiceBuilder to regenerate this class.

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.

Author:

Brian Wing Shun Chan

See Also:

LayoutService, LayoutServiceBaseImpl, com.liferay.portal.service.impl.LayoutServiceImpl

Generated:

Constructor Summary

LayoutServiceUtil()

Method Summary

static 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.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, ServiceContext serviceContext)
static 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)
static void	deleteLayout(long plid)
static void	deleteLayout(long groupId, boolean privateLayout, long layoutId)
static byte[]	exportLayouts(long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
static byte[]	exportLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
static java.io.File	exportLayoutsAsFile(long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
static byte[]	exportPortletInfo(long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
static java.io.File	exportPortletInfoAsFile(long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
static java.lang.String	getLayoutName(long groupId, boolean privateLayout, long layoutId, java.lang.String languageId)
static LayoutReference[]	getLayoutReferences(long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.String preferencesValue)
static LayoutService	getService()
static void	importLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, byte[] bytes)
static void	importLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file)
static void	importLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream is)
static void	importPortletInfo(long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file)
static void	importPortletInfo(long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream is)
static void	schedulePublishToLive(long sourceGroupId, long targetGroupId, 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 scope, 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)
static 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, 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)
static void	setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
void	setService(LayoutService service)
static void	unschedulePublishToLive(long groupId, java.lang.String jobName, java.lang.String groupName)
static void	unschedulePublishToRemote(long groupId, java.lang.String jobName, java.lang.String groupName)
static 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.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, java.lang.Boolean iconImage, byte[] iconBytes, ServiceContext serviceContext)
static 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.lang.String description, java.lang.String type, boolean hidden, java.lang.String friendlyURL, ServiceContext serviceContext)
static Layout	updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings)
static Layout	updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
static Layout	updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId)
static Layout	updateName(long plid, java.lang.String name, java.lang.String languageId)
static Layout	updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
static Layout	updateParentLayoutId(long plid, long parentPlid)
static Layout	updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
static Layout	updatePriority(long plid, int priority)

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

addLayout

public static 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.lang.String description,
                               java.lang.String type,
                               boolean hidden,
                               java.lang.String friendlyURL,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addLayout

public static 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,
                               SystemException

Throws:

PortalException

SystemException

deleteLayout

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

Throws:

PortalException

SystemException

deleteLayout

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

Throws:

PortalException

SystemException

exportLayouts

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

Throws:

PortalException

SystemException

exportLayouts

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

Throws:

PortalException

SystemException

exportLayoutsAsFile

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

Throws:

PortalException

SystemException

exportPortletInfo

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

Throws:

PortalException

SystemException

exportPortletInfoAsFile

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

Throws:

PortalException

SystemException

getLayoutName

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

Throws:

PortalException

SystemException

getLayoutReferences

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

Throws:

SystemException

importLayouts

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

Throws:

PortalException

SystemException

importLayouts

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

Throws:

PortalException

SystemException

importLayouts

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

Throws:

PortalException

SystemException

importPortletInfo

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

Throws:

PortalException

SystemException

importPortletInfo

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

Throws:

PortalException

SystemException

schedulePublishToLive

public static void schedulePublishToLive(long sourceGroupId,
                                         long targetGroupId,
                                         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 scope,
                                         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,
                                         SystemException

Throws:

PortalException

SystemException

schedulePublishToRemote

public static 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,
                                           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,
                                           SystemException

Throws:

PortalException

SystemException

setLayouts

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

Throws:

PortalException

SystemException

unschedulePublishToLive

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

Throws:

PortalException

SystemException

unschedulePublishToRemote

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

Throws:

PortalException

SystemException

updateLayout

public static 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.lang.String description,
                                  java.lang.String type,
                                  boolean hidden,
                                  java.lang.String friendlyURL,
                                  java.lang.Boolean iconImage,
                                  byte[] iconBytes,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateLayout

public static 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.lang.String description,
                                  java.lang.String type,
                                  boolean hidden,
                                  java.lang.String friendlyURL,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateLayout

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

Throws:

PortalException

SystemException

updateLookAndFeel

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

Throws:

PortalException

SystemException

updateName

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

Throws:

PortalException

SystemException

updateName

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

Throws:

PortalException

SystemException

updateParentLayoutId

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

Throws:

PortalException

SystemException

updateParentLayoutId

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

Throws:

PortalException

SystemException

updatePriority

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

Throws:

PortalException

SystemException

updatePriority

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

Throws:

PortalException

SystemException

getService

public static LayoutService getService()

setService

public void setService(LayoutService service)