com.liferay.portal.service
Interface LayoutService

@Transactional(rollbackFor={com.liferay.portal.PortalException.class,com.liferay.portal.SystemException.class})
public interface LayoutService

View Source

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

This interface defines the service. The default implementation is com.liferay.portal.service.impl.LayoutServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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:

LayoutServiceUtil

Method Summary

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)
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)
void	deleteLayout(long plid)
void	deleteLayout(long groupId, boolean privateLayout, long layoutId)
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)
byte[]	exportLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
com.liferay.portal.kernel.io.FileCacheOutputStream	exportLayoutsAsStream(long groupId, boolean privateLayout, long[] layoutIds, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.util.Date startDate, java.util.Date endDate)
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)
com.liferay.portal.kernel.io.FileCacheOutputStream	exportPortletInfoAsStream(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)
java.lang.String	getLayoutName(long groupId, boolean privateLayout, long layoutId, java.lang.String languageId)
LayoutReference[]	getLayoutReferences(long companyId, java.lang.String portletId, java.lang.String preferencesKey, java.lang.String preferencesValue)
void	importLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, byte[] bytes)
void	importLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file)
void	importLayouts(long groupId, boolean privateLayout, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream is)
void	importPortletInfo(long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.File file)
void	importPortletInfo(long plid, long groupId, java.lang.String portletId, java.util.Map<java.lang.String,java.lang.String[]> parameterMap, java.io.InputStream is)
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)
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)
void	setLayouts(long groupId, boolean privateLayout, long parentLayoutId, long[] layoutIds)
void	unschedulePublishToLive(long groupId, java.lang.String jobName, java.lang.String groupName)
void	unschedulePublishToRemote(long groupId, java.lang.String jobName, java.lang.String groupName)
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)
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)
Layout	updateLayout(long groupId, boolean privateLayout, long layoutId, java.lang.String typeSettings)
Layout	updateLookAndFeel(long groupId, boolean privateLayout, long layoutId, java.lang.String themeId, java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
Layout	updateName(long groupId, boolean privateLayout, long layoutId, java.lang.String name, java.lang.String languageId)
Layout	updateName(long plid, java.lang.String name, java.lang.String languageId)
Layout	updateParentLayoutId(long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
Layout	updateParentLayoutId(long plid, long parentPlid)
Layout	updatePriority(long groupId, boolean privateLayout, long layoutId, int priority)
Layout	updatePriority(long plid, int priority)

Method Detail

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)
                 throws com.liferay.portal.PortalException,
                        com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

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.lang.String description,
                 java.lang.String type,
                 boolean hidden,
                 java.lang.String friendlyURL)
                 throws com.liferay.portal.PortalException,
                        com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteLayout

void deleteLayout(long plid)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteLayout

void deleteLayout(long groupId,
                  boolean privateLayout,
                  long layoutId)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getLayoutName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.lang.String getLayoutName(long groupId,
                                             boolean privateLayout,
                                             long layoutId,
                                             java.lang.String languageId)
                               throws com.liferay.portal.PortalException,
                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getLayoutReferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutReference[] getLayoutReferences(long companyId,
                                                    java.lang.String portletId,
                                                    java.lang.String preferencesKey,
                                                    java.lang.String preferencesValue)
                                      throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

exportLayouts

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 com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

exportLayouts

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 com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

exportLayoutsAsStream

com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(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 com.liferay.portal.PortalException,
                                                                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

exportPortletInfo

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 com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

exportPortletInfoAsStream

com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(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 com.liferay.portal.PortalException,
                                                                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

importLayouts

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

importLayouts

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

importLayouts

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

importPortletInfo

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 com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

importPortletInfo

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 com.liferay.portal.PortalException,
                              com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

schedulePublishToLive

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 com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

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,
                             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 com.liferay.portal.PortalException,
                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

setLayouts

void setLayouts(long groupId,
                boolean privateLayout,
                long parentLayoutId,
                long[] layoutIds)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unschedulePublishToLive

void unschedulePublishToLive(long groupId,
                             java.lang.String jobName,
                             java.lang.String groupName)
                             throws com.liferay.portal.PortalException,
                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unschedulePublishToRemote

void unschedulePublishToRemote(long groupId,
                               java.lang.String jobName,
                               java.lang.String groupName)
                               throws com.liferay.portal.PortalException,
                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

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.lang.String description,
                    java.lang.String type,
                    boolean hidden,
                    java.lang.String friendlyURL)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateLayout

Layout updateLayout(long groupId,
                    boolean privateLayout,
                    long layoutId,
                    java.lang.String typeSettings)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateLookAndFeel

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

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateName

Layout updateName(long plid,
                  java.lang.String name,
                  java.lang.String languageId)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateName

Layout updateName(long groupId,
                  boolean privateLayout,
                  long layoutId,
                  java.lang.String name,
                  java.lang.String languageId)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateParentLayoutId

Layout updateParentLayoutId(long plid,
                            long parentPlid)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateParentLayoutId

Layout updateParentLayoutId(long groupId,
                            boolean privateLayout,
                            long layoutId,
                            long parentLayoutId)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updatePriority

Layout updatePriority(long plid,
                      int priority)
                      throws com.liferay.portal.PortalException,
                             com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updatePriority

Layout updatePriority(long groupId,
                      boolean privateLayout,
                      long layoutId,
                      int priority)
                      throws com.liferay.portal.PortalException,
                             com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException