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