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