1   /**
2    * Copyright (c) 2000-2008 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, java.lang.String portletId,
160         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
161         java.util.Date endDate)
162         throws com.liferay.portal.PortalException,
163             com.liferay.portal.SystemException;
164 
165     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
166         long plid, java.lang.String portletId,
167         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
168         java.util.Date endDate)
169         throws com.liferay.portal.PortalException,
170             com.liferay.portal.SystemException;
171 
172     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173     public long getDefaultPlid(long groupId)
174         throws com.liferay.portal.SystemException;
175 
176     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177     public long getDefaultPlid(long groupId, boolean privateLayout)
178         throws com.liferay.portal.SystemException;
179 
180     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181     public long getDefaultPlid(long groupId, boolean privateLayout,
182         java.lang.String portletId) throws com.liferay.portal.SystemException;
183 
184     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
186         throws com.liferay.portal.PortalException,
187             com.liferay.portal.SystemException;
188 
189     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
190         boolean privateLayout, java.lang.String friendlyURL)
191         throws com.liferay.portal.PortalException,
192             com.liferay.portal.SystemException;
193 
194     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195     public com.liferay.portal.model.Layout getLayout(long groupId,
196         boolean privateLayout, long layoutId)
197         throws com.liferay.portal.PortalException,
198             com.liferay.portal.SystemException;
199 
200     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201     public com.liferay.portal.model.Layout getLayoutByIconImageId(
202         long iconImageId)
203         throws com.liferay.portal.PortalException,
204             com.liferay.portal.SystemException;
205 
206     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
208         long groupId, boolean privateLayout)
209         throws com.liferay.portal.SystemException;
210 
211     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
213         long groupId, boolean privateLayout, long parentLayoutId)
214         throws com.liferay.portal.SystemException;
215 
216     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
218         long groupId, boolean privateLayout, java.lang.String type)
219         throws com.liferay.portal.SystemException;
220 
221     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
223         long groupId, boolean privateLayout, long parentLayoutId, int start,
224         int end) throws com.liferay.portal.SystemException;
225 
226     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
228         long groupId, boolean privateLayout, long[] layoutIds)
229         throws com.liferay.portal.PortalException,
230             com.liferay.portal.SystemException;
231 
232     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233     public com.liferay.portal.model.LayoutReference[] getLayouts(
234         long companyId, java.lang.String portletId, java.lang.String prefsKey,
235         java.lang.String prefsValue) throws com.liferay.portal.SystemException;
236 
237     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238     public long getNextLayoutId(long groupId, boolean privateLayout)
239         throws com.liferay.portal.SystemException;
240 
241     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
242     public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
243         throws com.liferay.portal.SystemException;
244 
245     public void importLayouts(long userId, long groupId, boolean privateLayout,
246         java.util.Map<String, String[]> parameterMap, java.io.File file)
247         throws com.liferay.portal.PortalException,
248             com.liferay.portal.SystemException;
249 
250     public void importLayouts(long userId, long groupId, boolean privateLayout,
251         java.util.Map<String, String[]> parameterMap, byte[] bytes)
252         throws com.liferay.portal.PortalException,
253             com.liferay.portal.SystemException;
254 
255     public void importLayouts(long userId, long groupId, boolean privateLayout,
256         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
257         throws com.liferay.portal.PortalException,
258             com.liferay.portal.SystemException;
259 
260     public void importPortletInfo(long userId, long plid,
261         java.lang.String portletId,
262         java.util.Map<String, String[]> parameterMap, java.io.File file)
263         throws com.liferay.portal.PortalException,
264             com.liferay.portal.SystemException;
265 
266     public void importPortletInfo(long userId, long plid,
267         java.lang.String portletId,
268         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
269         throws com.liferay.portal.PortalException,
270             com.liferay.portal.SystemException;
271 
272     public void setLayouts(long groupId, boolean privateLayout,
273         long parentLayoutId, long[] layoutIds)
274         throws com.liferay.portal.PortalException,
275             com.liferay.portal.SystemException;
276 
277     public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
278         java.lang.String friendlyURL)
279         throws com.liferay.portal.PortalException,
280             com.liferay.portal.SystemException;
281 
282     public com.liferay.portal.model.Layout updateLayout(long groupId,
283         boolean privateLayout, long layoutId, long parentLayoutId,
284         java.util.Map<java.util.Locale, String> localeNamesMap,
285         java.util.Map<java.util.Locale, String> localeTitlesMap,
286         java.lang.String description, java.lang.String type, boolean hidden,
287         java.lang.String friendlyURL)
288         throws com.liferay.portal.PortalException,
289             com.liferay.portal.SystemException;
290 
291     public com.liferay.portal.model.Layout updateLayout(long groupId,
292         boolean privateLayout, long layoutId, long parentLayoutId,
293         java.util.Map<java.util.Locale, String> localeNamesMap,
294         java.util.Map<java.util.Locale, String> localeTitlesMap,
295         java.lang.String description, java.lang.String type, boolean hidden,
296         java.lang.String friendlyURL, java.lang.Boolean iconImage,
297         byte[] iconBytes)
298         throws com.liferay.portal.PortalException,
299             com.liferay.portal.SystemException;
300 
301     public com.liferay.portal.model.Layout updateLayout(long groupId,
302         boolean privateLayout, long layoutId, java.lang.String typeSettings)
303         throws com.liferay.portal.PortalException,
304             com.liferay.portal.SystemException;
305 
306     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
307         boolean privateLayout, long layoutId, java.lang.String themeId,
308         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
309         throws com.liferay.portal.PortalException,
310             com.liferay.portal.SystemException;
311 
312     public com.liferay.portal.model.Layout updateName(long plid,
313         java.lang.String name, java.lang.String languageId)
314         throws com.liferay.portal.PortalException,
315             com.liferay.portal.SystemException;
316 
317     public com.liferay.portal.model.Layout updateName(long groupId,
318         boolean privateLayout, long layoutId, java.lang.String name,
319         java.lang.String languageId)
320         throws com.liferay.portal.PortalException,
321             com.liferay.portal.SystemException;
322 
323     public com.liferay.portal.model.Layout updateName(
324         com.liferay.portal.model.Layout layout, java.lang.String name,
325         java.lang.String languageId)
326         throws com.liferay.portal.PortalException,
327             com.liferay.portal.SystemException;
328 
329     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
330         long parentPlid)
331         throws com.liferay.portal.PortalException,
332             com.liferay.portal.SystemException;
333 
334     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
335         boolean privateLayout, long layoutId, long parentLayoutId)
336         throws com.liferay.portal.PortalException,
337             com.liferay.portal.SystemException;
338 
339     public com.liferay.portal.model.Layout updatePriority(long plid,
340         int priority)
341         throws com.liferay.portal.PortalException,
342             com.liferay.portal.SystemException;
343 
344     public com.liferay.portal.model.Layout updatePriority(long groupId,
345         boolean privateLayout, long layoutId, int priority)
346         throws com.liferay.portal.PortalException,
347             com.liferay.portal.SystemException;
348 
349     public com.liferay.portal.model.Layout updatePriority(
350         com.liferay.portal.model.Layout layout, int priority)
351         throws com.liferay.portal.SystemException;
352 }