1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="LayoutLocalService.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This interface defines the service. The default implementation is
40   * <code>com.liferay.portal.service.impl.LayoutLocalServiceImpl</code>.
41   * Modify methods in that class and rerun ServiceBuilder to populate this class
42   * and all other generated classes.
43   * </p>
44   *
45   * <p>
46   * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portal.service.LayoutLocalServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface LayoutLocalService {
57      public com.liferay.portal.model.Layout addLayout(
58          com.liferay.portal.model.Layout layout)
59          throws com.liferay.portal.SystemException;
60  
61      public com.liferay.portal.model.Layout createLayout(long plid);
62  
63      public void deleteLayout(long plid)
64          throws com.liferay.portal.SystemException,
65              com.liferay.portal.PortalException;
66  
67      public void deleteLayout(com.liferay.portal.model.Layout layout)
68          throws com.liferay.portal.SystemException;
69  
70      public java.util.List<Object> dynamicQuery(
71          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
72          throws com.liferay.portal.SystemException;
73  
74      public java.util.List<Object> dynamicQuery(
75          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
76          int end) throws com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portal.model.Layout getLayout(long plid)
80          throws com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException;
82  
83      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
84      public java.util.List<com.liferay.portal.model.Layout> getLayouts(
85          int start, int end) throws com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public int getLayoutsCount() throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Layout updateLayout(
91          com.liferay.portal.model.Layout layout)
92          throws com.liferay.portal.SystemException;
93  
94      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
95          boolean privateLayout, long parentLayoutId, java.lang.String name,
96          java.lang.String title, java.lang.String description,
97          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
102         boolean privateLayout, long parentLayoutId,
103         java.util.Map<java.util.Locale, String> localeNamesMap,
104         java.util.Map<java.util.Locale, String> localeTitlesMap,
105         java.lang.String description, java.lang.String type, boolean hidden,
106         java.lang.String friendlyURL)
107         throws com.liferay.portal.PortalException,
108             com.liferay.portal.SystemException;
109 
110     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
111         boolean privateLayout, long parentLayoutId, java.lang.String name,
112         java.lang.String title, java.lang.String description,
113         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
114         long dlFolderId)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
119         boolean privateLayout, long parentLayoutId,
120         java.util.Map<java.util.Locale, String> localeNamesMap,
121         java.util.Map<java.util.Locale, String> localeTitlesMap,
122         java.lang.String description, java.lang.String type, boolean hidden,
123         java.lang.String friendlyURL, long dlFolderId)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
128         throws com.liferay.portal.PortalException,
129             com.liferay.portal.SystemException;
130 
131     public void deleteLayout(com.liferay.portal.model.Layout layout,
132         boolean updateLayoutSet)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException;
135 
136     public void deleteLayouts(long groupId, boolean privateLayout)
137         throws com.liferay.portal.PortalException,
138             com.liferay.portal.SystemException;
139 
140     public byte[] exportLayouts(long groupId, boolean privateLayout,
141         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
142         java.util.Date endDate)
143         throws com.liferay.portal.PortalException,
144             com.liferay.portal.SystemException;
145 
146     public byte[] exportLayouts(long groupId, boolean privateLayout,
147         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
148         java.util.Date startDate, java.util.Date endDate)
149         throws com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException;
151 
152     public com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(
153         long groupId, boolean privateLayout, long[] layoutIds,
154         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
155         java.util.Date endDate)
156         throws com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException;
158 
159     public byte[] exportPortletInfo(long plid, long groupId,
160         java.lang.String portletId,
161         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
162         java.util.Date endDate)
163         throws com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException;
165 
166     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
167         long plid, long groupId, java.lang.String portletId,
168         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
169         java.util.Date endDate)
170         throws com.liferay.portal.PortalException,
171             com.liferay.portal.SystemException;
172 
173     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174     public long getDefaultPlid(long groupId)
175         throws com.liferay.portal.SystemException;
176 
177     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178     public long getDefaultPlid(long groupId, boolean privateLayout)
179         throws com.liferay.portal.SystemException;
180 
181     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182     public long getDefaultPlid(long groupId, boolean privateLayout,
183         java.lang.String portletId) throws com.liferay.portal.SystemException;
184 
185     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
186     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
187         throws com.liferay.portal.PortalException,
188             com.liferay.portal.SystemException;
189 
190     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
191         boolean privateLayout, java.lang.String friendlyURL)
192         throws com.liferay.portal.PortalException,
193             com.liferay.portal.SystemException;
194 
195     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196     public com.liferay.portal.model.Layout getLayout(long groupId,
197         boolean privateLayout, long layoutId)
198         throws com.liferay.portal.PortalException,
199             com.liferay.portal.SystemException;
200 
201     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202     public com.liferay.portal.model.Layout getLayoutByIconImageId(
203         long iconImageId)
204         throws com.liferay.portal.PortalException,
205             com.liferay.portal.SystemException;
206 
207     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
209         long groupId, boolean privateLayout)
210         throws com.liferay.portal.SystemException;
211 
212     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
214         long groupId, boolean privateLayout, long parentLayoutId)
215         throws com.liferay.portal.SystemException;
216 
217     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
219         long groupId, boolean privateLayout, java.lang.String type)
220         throws com.liferay.portal.SystemException;
221 
222     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
224         long groupId, boolean privateLayout, long parentLayoutId, int start,
225         int end) throws com.liferay.portal.SystemException;
226 
227     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
228     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
229         long groupId, boolean privateLayout, long[] layoutIds)
230         throws com.liferay.portal.PortalException,
231             com.liferay.portal.SystemException;
232 
233     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
234     public com.liferay.portal.model.LayoutReference[] getLayouts(
235         long companyId, java.lang.String portletId,
236         java.lang.String preferencesKey, java.lang.String preferencesValue)
237         throws com.liferay.portal.SystemException;
238 
239     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240     public long getNextLayoutId(long groupId, boolean privateLayout)
241         throws com.liferay.portal.SystemException;
242 
243     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244     public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
245         throws com.liferay.portal.SystemException;
246 
247     public void importLayouts(long userId, long groupId, boolean privateLayout,
248         java.util.Map<String, String[]> parameterMap, java.io.File file)
249         throws com.liferay.portal.PortalException,
250             com.liferay.portal.SystemException;
251 
252     public void importLayouts(long userId, long groupId, boolean privateLayout,
253         java.util.Map<String, String[]> parameterMap, byte[] bytes)
254         throws com.liferay.portal.PortalException,
255             com.liferay.portal.SystemException;
256 
257     public void importLayouts(long userId, long groupId, boolean privateLayout,
258         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
259         throws com.liferay.portal.PortalException,
260             com.liferay.portal.SystemException;
261 
262     public void importPortletInfo(long userId, long plid, long groupId,
263         java.lang.String portletId,
264         java.util.Map<String, String[]> parameterMap, java.io.File file)
265         throws com.liferay.portal.PortalException,
266             com.liferay.portal.SystemException;
267 
268     public void importPortletInfo(long userId, long plid, long groupId,
269         java.lang.String portletId,
270         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
271         throws com.liferay.portal.PortalException,
272             com.liferay.portal.SystemException;
273 
274     public void setLayouts(long groupId, boolean privateLayout,
275         long parentLayoutId, long[] layoutIds)
276         throws com.liferay.portal.PortalException,
277             com.liferay.portal.SystemException;
278 
279     public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
280         java.lang.String friendlyURL)
281         throws com.liferay.portal.PortalException,
282             com.liferay.portal.SystemException;
283 
284     public com.liferay.portal.model.Layout updateLayout(long groupId,
285         boolean privateLayout, long layoutId, long parentLayoutId,
286         java.util.Map<java.util.Locale, String> localeNamesMap,
287         java.util.Map<java.util.Locale, String> localeTitlesMap,
288         java.lang.String description, java.lang.String type, boolean hidden,
289         java.lang.String friendlyURL)
290         throws com.liferay.portal.PortalException,
291             com.liferay.portal.SystemException;
292 
293     public com.liferay.portal.model.Layout updateLayout(long groupId,
294         boolean privateLayout, long layoutId, long parentLayoutId,
295         java.util.Map<java.util.Locale, String> localeNamesMap,
296         java.util.Map<java.util.Locale, String> localeTitlesMap,
297         java.lang.String description, java.lang.String type, boolean hidden,
298         java.lang.String friendlyURL, java.lang.Boolean iconImage,
299         byte[] iconBytes)
300         throws com.liferay.portal.PortalException,
301             com.liferay.portal.SystemException;
302 
303     public com.liferay.portal.model.Layout updateLayout(long groupId,
304         boolean privateLayout, long layoutId, java.lang.String typeSettings)
305         throws com.liferay.portal.PortalException,
306             com.liferay.portal.SystemException;
307 
308     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
309         boolean privateLayout, long layoutId, java.lang.String themeId,
310         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
311         throws com.liferay.portal.PortalException,
312             com.liferay.portal.SystemException;
313 
314     public com.liferay.portal.model.Layout updateName(long plid,
315         java.lang.String name, java.lang.String languageId)
316         throws com.liferay.portal.PortalException,
317             com.liferay.portal.SystemException;
318 
319     public com.liferay.portal.model.Layout updateName(long groupId,
320         boolean privateLayout, long layoutId, java.lang.String name,
321         java.lang.String languageId)
322         throws com.liferay.portal.PortalException,
323             com.liferay.portal.SystemException;
324 
325     public com.liferay.portal.model.Layout updateName(
326         com.liferay.portal.model.Layout layout, java.lang.String name,
327         java.lang.String languageId)
328         throws com.liferay.portal.PortalException,
329             com.liferay.portal.SystemException;
330 
331     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
332         long parentPlid)
333         throws com.liferay.portal.PortalException,
334             com.liferay.portal.SystemException;
335 
336     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
337         boolean privateLayout, long layoutId, long parentLayoutId)
338         throws com.liferay.portal.PortalException,
339             com.liferay.portal.SystemException;
340 
341     public com.liferay.portal.model.Layout updatePriority(long plid,
342         int priority)
343         throws com.liferay.portal.PortalException,
344             com.liferay.portal.SystemException;
345 
346     public com.liferay.portal.model.Layout updatePriority(long groupId,
347         boolean privateLayout, long layoutId, int priority)
348         throws com.liferay.portal.PortalException,
349             com.liferay.portal.SystemException;
350 
351     public com.liferay.portal.model.Layout updatePriority(
352         com.liferay.portal.model.Layout layout, int priority)
353         throws com.liferay.portal.SystemException;
354 }