001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the layout remote service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link LayoutServiceUtil} to access the layout remote service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see LayoutServiceUtil
036     * @see com.liferay.portal.service.base.LayoutServiceBaseImpl
037     * @see com.liferay.portal.service.impl.LayoutServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface LayoutService {
043            public com.liferay.portal.model.Layout addLayout(long groupId,
044                    boolean privateLayout, long parentLayoutId,
045                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
046                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
047                    java.lang.String description, java.lang.String type, boolean hidden,
048                    java.lang.String friendlyURL,
049                    com.liferay.portal.service.ServiceContext serviceContext)
050                    throws com.liferay.portal.kernel.exception.PortalException,
051                            com.liferay.portal.kernel.exception.SystemException;
052    
053            public com.liferay.portal.model.Layout addLayout(long groupId,
054                    boolean privateLayout, long parentLayoutId, java.lang.String name,
055                    java.lang.String title, java.lang.String description,
056                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
057                    com.liferay.portal.service.ServiceContext serviceContext)
058                    throws com.liferay.portal.kernel.exception.PortalException,
059                            com.liferay.portal.kernel.exception.SystemException;
060    
061            public void deleteLayout(long plid)
062                    throws com.liferay.portal.kernel.exception.PortalException,
063                            com.liferay.portal.kernel.exception.SystemException;
064    
065            public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
066                    throws com.liferay.portal.kernel.exception.PortalException,
067                            com.liferay.portal.kernel.exception.SystemException;
068    
069            public byte[] exportLayouts(long groupId, boolean privateLayout,
070                    long[] layoutIds,
071                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
072                    java.util.Date startDate, java.util.Date endDate)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            public byte[] exportLayouts(long groupId, boolean privateLayout,
077                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
078                    java.util.Date startDate, java.util.Date endDate)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            public java.io.File exportLayoutsAsFile(long groupId,
083                    boolean privateLayout, long[] layoutIds,
084                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
085                    java.util.Date startDate, java.util.Date endDate)
086                    throws com.liferay.portal.kernel.exception.PortalException,
087                            com.liferay.portal.kernel.exception.SystemException;
088    
089            public byte[] exportPortletInfo(long plid, long groupId,
090                    java.lang.String portletId,
091                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
092                    java.util.Date startDate, java.util.Date endDate)
093                    throws com.liferay.portal.kernel.exception.PortalException,
094                            com.liferay.portal.kernel.exception.SystemException;
095    
096            public java.io.File exportPortletInfoAsFile(long plid, long groupId,
097                    java.lang.String portletId,
098                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
099                    java.util.Date startDate, java.util.Date endDate)
100                    throws com.liferay.portal.kernel.exception.PortalException,
101                            com.liferay.portal.kernel.exception.SystemException;
102    
103            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104            public java.lang.String getLayoutName(long groupId, boolean privateLayout,
105                    long layoutId, java.lang.String languageId)
106                    throws com.liferay.portal.kernel.exception.PortalException,
107                            com.liferay.portal.kernel.exception.SystemException;
108    
109            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
110            public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
111                    long companyId, java.lang.String portletId,
112                    java.lang.String preferencesKey, java.lang.String preferencesValue)
113                    throws com.liferay.portal.kernel.exception.SystemException;
114    
115            public void importLayouts(long groupId, boolean privateLayout,
116                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
117                    byte[] bytes)
118                    throws com.liferay.portal.kernel.exception.PortalException,
119                            com.liferay.portal.kernel.exception.SystemException;
120    
121            public void importLayouts(long groupId, boolean privateLayout,
122                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
123                    java.io.File file)
124                    throws com.liferay.portal.kernel.exception.PortalException,
125                            com.liferay.portal.kernel.exception.SystemException;
126    
127            public void importLayouts(long groupId, boolean privateLayout,
128                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
129                    java.io.InputStream is)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException;
132    
133            public void importPortletInfo(long plid, long groupId,
134                    java.lang.String portletId,
135                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
136                    java.io.File file)
137                    throws com.liferay.portal.kernel.exception.PortalException,
138                            com.liferay.portal.kernel.exception.SystemException;
139    
140            public void importPortletInfo(long plid, long groupId,
141                    java.lang.String portletId,
142                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
143                    java.io.InputStream is)
144                    throws com.liferay.portal.kernel.exception.PortalException,
145                            com.liferay.portal.kernel.exception.SystemException;
146    
147            public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
148                    boolean privateLayout,
149                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
150                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
151                    java.lang.String scope, java.util.Date startDate,
152                    java.util.Date endDate, java.lang.String groupName,
153                    java.lang.String cronText, java.util.Date schedulerStartDate,
154                    java.util.Date schedulerEndDate, java.lang.String description)
155                    throws com.liferay.portal.kernel.exception.PortalException,
156                            com.liferay.portal.kernel.exception.SystemException;
157    
158            public void schedulePublishToRemote(long sourceGroupId,
159                    boolean privateLayout,
160                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
161                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
162                    java.lang.String remoteAddress, int remotePort,
163                    boolean secureConnection, long remoteGroupId,
164                    boolean remotePrivateLayout, java.util.Date startDate,
165                    java.util.Date endDate, java.lang.String groupName,
166                    java.lang.String cronText, java.util.Date schedulerStartDate,
167                    java.util.Date schedulerEndDate, java.lang.String description)
168                    throws com.liferay.portal.kernel.exception.PortalException,
169                            com.liferay.portal.kernel.exception.SystemException;
170    
171            public void setLayouts(long groupId, boolean privateLayout,
172                    long parentLayoutId, long[] layoutIds)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException;
175    
176            public void unschedulePublishToLive(long groupId, java.lang.String jobName,
177                    java.lang.String groupName)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            public void unschedulePublishToRemote(long groupId,
182                    java.lang.String jobName, java.lang.String groupName)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException;
185    
186            public com.liferay.portal.model.Layout updateLayout(long groupId,
187                    boolean privateLayout, long layoutId, long parentLayoutId,
188                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
189                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
190                    java.lang.String description, java.lang.String type, boolean hidden,
191                    java.lang.String friendlyURL, java.lang.Boolean iconImage,
192                    byte[] iconBytes,
193                    com.liferay.portal.service.ServiceContext serviceContext)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException;
196    
197            public com.liferay.portal.model.Layout updateLayout(long groupId,
198                    boolean privateLayout, long layoutId, long parentLayoutId,
199                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
200                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
201                    java.lang.String description, java.lang.String type, boolean hidden,
202                    java.lang.String friendlyURL,
203                    com.liferay.portal.service.ServiceContext serviceContext)
204                    throws com.liferay.portal.kernel.exception.PortalException,
205                            com.liferay.portal.kernel.exception.SystemException;
206    
207            public com.liferay.portal.model.Layout updateLayout(long groupId,
208                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException;
211    
212            public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
213                    boolean privateLayout, long layoutId, java.lang.String themeId,
214                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
215                    throws com.liferay.portal.kernel.exception.PortalException,
216                            com.liferay.portal.kernel.exception.SystemException;
217    
218            public com.liferay.portal.model.Layout updateName(long groupId,
219                    boolean privateLayout, long layoutId, java.lang.String name,
220                    java.lang.String languageId)
221                    throws com.liferay.portal.kernel.exception.PortalException,
222                            com.liferay.portal.kernel.exception.SystemException;
223    
224            public com.liferay.portal.model.Layout updateName(long plid,
225                    java.lang.String name, java.lang.String languageId)
226                    throws com.liferay.portal.kernel.exception.PortalException,
227                            com.liferay.portal.kernel.exception.SystemException;
228    
229            public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
230                    boolean privateLayout, long layoutId, long parentLayoutId)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
235                    long parentPlid)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException;
238    
239            public com.liferay.portal.model.Layout updatePriority(long groupId,
240                    boolean privateLayout, long layoutId, int priority)
241                    throws com.liferay.portal.kernel.exception.PortalException,
242                            com.liferay.portal.kernel.exception.SystemException;
243    
244            public com.liferay.portal.model.Layout updatePriority(long plid,
245                    int priority)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException;
248    }