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 com.liferay.portal.model.Layout createLayout(long plid);
56  
57      public void deleteLayout(long plid)
58          throws com.liferay.portal.SystemException,
59              com.liferay.portal.PortalException;
60  
61      public void deleteLayout(com.liferay.portal.model.Layout layout)
62          throws com.liferay.portal.SystemException;
63  
64      public java.util.List<Object> dynamicQuery(
65          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<Object> dynamicQuery(
69          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
70          int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.Layout getLayout(long plid)
73          throws com.liferay.portal.SystemException,
74              com.liferay.portal.PortalException;
75  
76      public java.util.List<com.liferay.portal.model.Layout> getLayouts(
77          int start, int end) throws com.liferay.portal.SystemException;
78  
79      public int getLayoutsCount() throws com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.Layout updateLayout(
82          com.liferay.portal.model.Layout layout)
83          throws com.liferay.portal.SystemException;
84  
85      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
86          boolean privateLayout, long parentLayoutId, java.lang.String name,
87          java.lang.String title, java.lang.String description,
88          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
89          throws com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException;
91  
92      public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
93          boolean privateLayout, long parentLayoutId,
94          java.util.Map<java.util.Locale, String> localeNamesMap,
95          java.util.Map<java.util.Locale, String> localeTitlesMap,
96          java.lang.String description, java.lang.String type, boolean hidden,
97          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, java.lang.String name,
103         java.lang.String title, java.lang.String description,
104         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
105         long dlFolderId)
106         throws com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
110         boolean privateLayout, long parentLayoutId,
111         java.util.Map<java.util.Locale, String> localeNamesMap,
112         java.util.Map<java.util.Locale, String> localeTitlesMap,
113         java.lang.String description, java.lang.String type, boolean hidden,
114         java.lang.String friendlyURL, long dlFolderId)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
119         throws com.liferay.portal.PortalException,
120             com.liferay.portal.SystemException;
121 
122     public void deleteLayout(com.liferay.portal.model.Layout layout,
123         boolean updateLayoutSet)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public void deleteLayouts(long groupId, boolean privateLayout)
128         throws com.liferay.portal.PortalException,
129             com.liferay.portal.SystemException;
130 
131     public byte[] exportLayouts(long groupId, boolean privateLayout,
132         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
133         java.util.Date endDate)
134         throws com.liferay.portal.PortalException,
135             com.liferay.portal.SystemException;
136 
137     public byte[] exportLayouts(long groupId, boolean privateLayout,
138         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
139         java.util.Date startDate, java.util.Date endDate)
140         throws com.liferay.portal.PortalException,
141             com.liferay.portal.SystemException;
142 
143     public byte[] exportPortletInfo(long plid, java.lang.String portletId,
144         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
145         java.util.Date endDate)
146         throws com.liferay.portal.PortalException,
147             com.liferay.portal.SystemException;
148 
149     public long getDefaultPlid(long groupId)
150         throws com.liferay.portal.SystemException;
151 
152     public long getDefaultPlid(long groupId, boolean privateLayout)
153         throws com.liferay.portal.SystemException;
154 
155     public long getDefaultPlid(long groupId, boolean privateLayout,
156         java.lang.String portletId) throws com.liferay.portal.SystemException;
157 
158     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
159         throws com.liferay.portal.PortalException,
160             com.liferay.portal.SystemException;
161 
162     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
163         boolean privateLayout, java.lang.String friendlyURL)
164         throws com.liferay.portal.PortalException,
165             com.liferay.portal.SystemException;
166 
167     public com.liferay.portal.model.Layout getLayout(long groupId,
168         boolean privateLayout, long layoutId)
169         throws com.liferay.portal.PortalException,
170             com.liferay.portal.SystemException;
171 
172     public com.liferay.portal.model.Layout getLayoutByIconImageId(
173         long iconImageId)
174         throws com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException;
176 
177     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
178         long groupId, boolean privateLayout)
179         throws com.liferay.portal.SystemException;
180 
181     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
182         long groupId, boolean privateLayout, long parentLayoutId)
183         throws com.liferay.portal.SystemException;
184 
185     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
186         long groupId, boolean privateLayout, java.lang.String type)
187         throws com.liferay.portal.SystemException;
188 
189     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
190         long groupId, boolean privateLayout, long parentLayoutId, int start,
191         int end) throws com.liferay.portal.SystemException;
192 
193     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
194         long groupId, boolean privateLayout, long[] layoutIds)
195         throws com.liferay.portal.PortalException,
196             com.liferay.portal.SystemException;
197 
198     public com.liferay.portal.model.LayoutReference[] getLayouts(
199         long companyId, java.lang.String portletId, java.lang.String prefsKey,
200         java.lang.String prefsValue) throws com.liferay.portal.SystemException;
201 
202     public long getNextLayoutId(long groupId, boolean privateLayout)
203         throws com.liferay.portal.SystemException;
204 
205     public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
206         throws com.liferay.portal.SystemException;
207 
208     public void importLayouts(long userId, long groupId, boolean privateLayout,
209         java.util.Map<String, String[]> parameterMap, java.io.File file)
210         throws com.liferay.portal.PortalException,
211             com.liferay.portal.SystemException;
212 
213     public void importLayouts(long userId, long groupId, boolean privateLayout,
214         java.util.Map<String, String[]> parameterMap, byte[] bytes)
215         throws com.liferay.portal.PortalException,
216             com.liferay.portal.SystemException;
217 
218     public void importLayouts(long userId, long groupId, boolean privateLayout,
219         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
220         throws com.liferay.portal.PortalException,
221             com.liferay.portal.SystemException;
222 
223     public void importPortletInfo(long userId, long plid,
224         java.lang.String portletId,
225         java.util.Map<String, String[]> parameterMap, java.io.File file)
226         throws com.liferay.portal.PortalException,
227             com.liferay.portal.SystemException;
228 
229     public void importPortletInfo(long userId, long plid,
230         java.lang.String portletId,
231         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
232         throws com.liferay.portal.PortalException,
233             com.liferay.portal.SystemException;
234 
235     public void setLayouts(long groupId, boolean privateLayout,
236         long parentLayoutId, long[] layoutIds)
237         throws com.liferay.portal.PortalException,
238             com.liferay.portal.SystemException;
239 
240     public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
241         java.lang.String friendlyURL)
242         throws com.liferay.portal.PortalException,
243             com.liferay.portal.SystemException;
244 
245     public com.liferay.portal.model.Layout updateLayout(long groupId,
246         boolean privateLayout, long layoutId, long parentLayoutId,
247         java.util.Map<java.util.Locale, String> localeNamesMap,
248         java.util.Map<java.util.Locale, String> localeTitlesMap,
249         java.lang.String description, java.lang.String type, boolean hidden,
250         java.lang.String friendlyURL)
251         throws com.liferay.portal.PortalException,
252             com.liferay.portal.SystemException;
253 
254     public com.liferay.portal.model.Layout updateLayout(long groupId,
255         boolean privateLayout, long layoutId, long parentLayoutId,
256         java.util.Map<java.util.Locale, String> localeNamesMap,
257         java.util.Map<java.util.Locale, String> localeTitlesMap,
258         java.lang.String description, java.lang.String type, boolean hidden,
259         java.lang.String friendlyURL, java.lang.Boolean iconImage,
260         byte[] iconBytes)
261         throws com.liferay.portal.PortalException,
262             com.liferay.portal.SystemException;
263 
264     public com.liferay.portal.model.Layout updateLayout(long groupId,
265         boolean privateLayout, long layoutId, java.lang.String typeSettings)
266         throws com.liferay.portal.PortalException,
267             com.liferay.portal.SystemException;
268 
269     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
270         boolean privateLayout, long layoutId, java.lang.String themeId,
271         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
272         throws com.liferay.portal.PortalException,
273             com.liferay.portal.SystemException;
274 
275     public com.liferay.portal.model.Layout updateName(long plid,
276         java.lang.String name, java.lang.String languageId)
277         throws com.liferay.portal.PortalException,
278             com.liferay.portal.SystemException;
279 
280     public com.liferay.portal.model.Layout updateName(long groupId,
281         boolean privateLayout, long layoutId, java.lang.String name,
282         java.lang.String languageId)
283         throws com.liferay.portal.PortalException,
284             com.liferay.portal.SystemException;
285 
286     public com.liferay.portal.model.Layout updateName(
287         com.liferay.portal.model.Layout layout, java.lang.String name,
288         java.lang.String languageId)
289         throws com.liferay.portal.PortalException,
290             com.liferay.portal.SystemException;
291 
292     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
293         long parentPlid)
294         throws com.liferay.portal.PortalException,
295             com.liferay.portal.SystemException;
296 
297     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
298         boolean privateLayout, long layoutId, long parentLayoutId)
299         throws com.liferay.portal.PortalException,
300             com.liferay.portal.SystemException;
301 
302     public com.liferay.portal.model.Layout updatePriority(long plid,
303         int priority)
304         throws com.liferay.portal.PortalException,
305             com.liferay.portal.SystemException;
306 
307     public com.liferay.portal.model.Layout updatePriority(long groupId,
308         boolean privateLayout, long layoutId, int priority)
309         throws com.liferay.portal.PortalException,
310             com.liferay.portal.SystemException;
311 
312     public com.liferay.portal.model.Layout updatePriority(
313         com.liferay.portal.model.Layout layout, int priority)
314         throws com.liferay.portal.SystemException;
315 }