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  
26  /**
27   * <a href="LayoutLocalService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.LayoutLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.LayoutLocalServiceUtil
48   *
49   */
50  public interface LayoutLocalService {
51      public com.liferay.portal.model.Layout addLayout(
52          com.liferay.portal.model.Layout layout)
53          throws com.liferay.portal.SystemException;
54  
55      public void deleteLayout(long plid)
56          throws com.liferay.portal.SystemException,
57              com.liferay.portal.PortalException;
58  
59      public void deleteLayout(com.liferay.portal.model.Layout layout)
60          throws com.liferay.portal.SystemException;
61  
62      public java.util.List<Object> dynamicQuery(
63          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
64          throws com.liferay.portal.SystemException;
65  
66      public java.util.List<Object> dynamicQuery(
67          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
68          int end) throws com.liferay.portal.SystemException;
69  
70      public com.liferay.portal.model.Layout getLayout(long plid)
71          throws com.liferay.portal.SystemException,
72              com.liferay.portal.PortalException;
73  
74      public java.util.List<com.liferay.portal.model.Layout> getLayouts(
75          int start, int end) throws com.liferay.portal.SystemException;
76  
77      public int getLayoutsCount() throws com.liferay.portal.SystemException;
78  
79      public com.liferay.portal.model.Layout updateLayout(
80          com.liferay.portal.model.Layout layout)
81          throws com.liferay.portal.SystemException;
82  
83      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
84          boolean privateLayout, long parentLayoutId, java.lang.String name,
85          java.lang.String title, java.lang.String description,
86          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
87          throws com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
91          boolean privateLayout, long parentLayoutId,
92          java.util.Map<java.util.Locale, String> localeNamesMap,
93          java.util.Map<java.util.Locale, String> localeTitlesMap,
94          java.lang.String description, java.lang.String type, boolean hidden,
95          java.lang.String friendlyURL)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
100         boolean privateLayout, long parentLayoutId, java.lang.String name,
101         java.lang.String title, java.lang.String description,
102         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
103         long dlFolderId)
104         throws com.liferay.portal.PortalException,
105             com.liferay.portal.SystemException;
106 
107     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
108         boolean privateLayout, long parentLayoutId,
109         java.util.Map<java.util.Locale, String> localeNamesMap,
110         java.util.Map<java.util.Locale, String> localeTitlesMap,
111         java.lang.String description, java.lang.String type, boolean hidden,
112         java.lang.String friendlyURL, long dlFolderId)
113         throws com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException;
115 
116     public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException;
119 
120     public void deleteLayout(com.liferay.portal.model.Layout layout,
121         boolean updateLayoutSet)
122         throws com.liferay.portal.PortalException,
123             com.liferay.portal.SystemException;
124 
125     public void deleteLayouts(long groupId, boolean privateLayout)
126         throws com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException;
128 
129     public byte[] exportLayouts(long groupId, boolean privateLayout,
130         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
131         java.util.Date endDate)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     public byte[] exportLayouts(long groupId, boolean privateLayout,
136         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
137         java.util.Date startDate, java.util.Date endDate)
138         throws com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public byte[] exportPortletInfo(long plid, java.lang.String portletId,
142         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
143         java.util.Date endDate)
144         throws com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException;
146 
147     public long getDefaultPlid(long groupId)
148         throws com.liferay.portal.SystemException;
149 
150     public long getDefaultPlid(long groupId, boolean privateLayout)
151         throws com.liferay.portal.SystemException;
152 
153     public long getDefaultPlid(long groupId, boolean privateLayout,
154         java.lang.String portletId) throws com.liferay.portal.SystemException;
155 
156     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
157         throws com.liferay.portal.PortalException,
158             com.liferay.portal.SystemException;
159 
160     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
161         boolean privateLayout, java.lang.String friendlyURL)
162         throws com.liferay.portal.PortalException,
163             com.liferay.portal.SystemException;
164 
165     public com.liferay.portal.model.Layout getLayout(long groupId,
166         boolean privateLayout, long layoutId)
167         throws com.liferay.portal.PortalException,
168             com.liferay.portal.SystemException;
169 
170     public com.liferay.portal.model.Layout getLayoutByIconImageId(
171         long iconImageId)
172         throws com.liferay.portal.PortalException,
173             com.liferay.portal.SystemException;
174 
175     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
176         long groupId, boolean privateLayout)
177         throws com.liferay.portal.SystemException;
178 
179     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
180         long groupId, boolean privateLayout, long parentLayoutId)
181         throws com.liferay.portal.SystemException;
182 
183     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
184         long groupId, boolean privateLayout, java.lang.String type)
185         throws com.liferay.portal.SystemException;
186 
187     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
188         long groupId, boolean privateLayout, long parentLayoutId, int start,
189         int end) throws com.liferay.portal.SystemException;
190 
191     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
192         long groupId, boolean privateLayout, long[] layoutIds)
193         throws com.liferay.portal.PortalException,
194             com.liferay.portal.SystemException;
195 
196     public com.liferay.portal.model.LayoutReference[] getLayouts(
197         long companyId, java.lang.String portletId, java.lang.String prefsKey,
198         java.lang.String prefsValue) throws com.liferay.portal.SystemException;
199 
200     public long getNextLayoutId(long groupId, boolean privateLayout)
201         throws com.liferay.portal.SystemException;
202 
203     public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
204         throws com.liferay.portal.SystemException;
205 
206     public void importLayouts(long userId, long groupId, boolean privateLayout,
207         java.util.Map<String, String[]> parameterMap, java.io.File file)
208         throws com.liferay.portal.PortalException,
209             com.liferay.portal.SystemException;
210 
211     public void importLayouts(long userId, long groupId, boolean privateLayout,
212         java.util.Map<String, String[]> parameterMap, byte[] bytes)
213         throws com.liferay.portal.PortalException,
214             com.liferay.portal.SystemException;
215 
216     public void importLayouts(long userId, long groupId, boolean privateLayout,
217         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
218         throws com.liferay.portal.PortalException,
219             com.liferay.portal.SystemException;
220 
221     public void importPortletInfo(long userId, long plid,
222         java.lang.String portletId,
223         java.util.Map<String, String[]> parameterMap, java.io.File file)
224         throws com.liferay.portal.PortalException,
225             com.liferay.portal.SystemException;
226 
227     public void importPortletInfo(long userId, long plid,
228         java.lang.String portletId,
229         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
230         throws com.liferay.portal.PortalException,
231             com.liferay.portal.SystemException;
232 
233     public void setLayouts(long groupId, boolean privateLayout,
234         long parentLayoutId, long[] layoutIds)
235         throws com.liferay.portal.PortalException,
236             com.liferay.portal.SystemException;
237 
238     public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
239         java.lang.String friendlyURL)
240         throws com.liferay.portal.PortalException,
241             com.liferay.portal.SystemException;
242 
243     public com.liferay.portal.model.Layout updateLayout(long groupId,
244         boolean privateLayout, long layoutId, long parentLayoutId,
245         java.util.Map<java.util.Locale, String> localeNamesMap,
246         java.util.Map<java.util.Locale, String> localeTitlesMap,
247         java.lang.String description, java.lang.String type, boolean hidden,
248         java.lang.String friendlyURL)
249         throws com.liferay.portal.PortalException,
250             com.liferay.portal.SystemException;
251 
252     public com.liferay.portal.model.Layout updateLayout(long groupId,
253         boolean privateLayout, long layoutId, long parentLayoutId,
254         java.util.Map<java.util.Locale, String> localeNamesMap,
255         java.util.Map<java.util.Locale, String> localeTitlesMap,
256         java.lang.String description, java.lang.String type, boolean hidden,
257         java.lang.String friendlyURL, java.lang.Boolean iconImage,
258         byte[] iconBytes)
259         throws com.liferay.portal.PortalException,
260             com.liferay.portal.SystemException;
261 
262     public com.liferay.portal.model.Layout updateLayout(long groupId,
263         boolean privateLayout, long layoutId, java.lang.String typeSettings)
264         throws com.liferay.portal.PortalException,
265             com.liferay.portal.SystemException;
266 
267     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
268         boolean privateLayout, long layoutId, java.lang.String themeId,
269         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
270         throws com.liferay.portal.PortalException,
271             com.liferay.portal.SystemException;
272 
273     public com.liferay.portal.model.Layout updateName(long plid,
274         java.lang.String name, java.lang.String languageId)
275         throws com.liferay.portal.PortalException,
276             com.liferay.portal.SystemException;
277 
278     public com.liferay.portal.model.Layout updateName(long groupId,
279         boolean privateLayout, long layoutId, java.lang.String name,
280         java.lang.String languageId)
281         throws com.liferay.portal.PortalException,
282             com.liferay.portal.SystemException;
283 
284     public com.liferay.portal.model.Layout updateName(
285         com.liferay.portal.model.Layout layout, java.lang.String name,
286         java.lang.String languageId)
287         throws com.liferay.portal.PortalException,
288             com.liferay.portal.SystemException;
289 
290     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
291         long parentPlid)
292         throws com.liferay.portal.PortalException,
293             com.liferay.portal.SystemException;
294 
295     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
296         boolean privateLayout, long layoutId, long parentLayoutId)
297         throws com.liferay.portal.PortalException,
298             com.liferay.portal.SystemException;
299 
300     public com.liferay.portal.model.Layout updatePriority(long plid,
301         int priority)
302         throws com.liferay.portal.PortalException,
303             com.liferay.portal.SystemException;
304 
305     public com.liferay.portal.model.Layout updatePriority(long groupId,
306         boolean privateLayout, long layoutId, int priority)
307         throws com.liferay.portal.PortalException,
308             com.liferay.portal.SystemException;
309 
310     public com.liferay.portal.model.Layout updatePriority(
311         com.liferay.portal.model.Layout layout, int priority)
312         throws com.liferay.portal.SystemException;
313 }