1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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.Isolation;
28  import com.liferay.portal.kernel.annotation.Propagation;
29  import com.liferay.portal.kernel.annotation.Transactional;
30  
31  /**
32   * <a href="LayoutLocalService.java.html"><b><i>View Source</i></b></a>
33   *
34   * <p>
35   * ServiceBuilder generated this class. Modifications in this class will be
36   * overwritten the next time is generated.
37   * </p>
38   *
39   * <p>
40   * This interface defines the service. The default implementation is
41   * {@link
42   * com.liferay.portal.service.impl.LayoutLocalServiceImpl}}.
43   * Modify methods in that class and rerun ServiceBuilder to populate this class
44   * and all other generated classes.
45   * </p>
46   *
47   * <p>
48   * 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.
49   * </p>
50   *
51   * @author    Brian Wing Shun Chan
52   * @see       LayoutLocalServiceUtil
53   * @generated
54   */
55  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
56      PortalException.class, SystemException.class})
57  public interface LayoutLocalService {
58      public com.liferay.portal.model.Layout addLayout(
59          com.liferay.portal.model.Layout layout)
60          throws com.liferay.portal.SystemException;
61  
62      public com.liferay.portal.model.Layout createLayout(long plid);
63  
64      public void deleteLayout(long plid)
65          throws com.liferay.portal.PortalException,
66              com.liferay.portal.SystemException;
67  
68      public void deleteLayout(com.liferay.portal.model.Layout layout)
69          throws com.liferay.portal.SystemException;
70  
71      public java.util.List<Object> dynamicQuery(
72          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
73          throws com.liferay.portal.SystemException;
74  
75      public java.util.List<Object> dynamicQuery(
76          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
77          int end) throws com.liferay.portal.SystemException;
78  
79      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
80      public com.liferay.portal.model.Layout getLayout(long plid)
81          throws com.liferay.portal.PortalException,
82              com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public java.util.List<com.liferay.portal.model.Layout> getLayouts(
86          int start, int end) throws com.liferay.portal.SystemException;
87  
88      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
89      public int getLayoutsCount() throws com.liferay.portal.SystemException;
90  
91      public com.liferay.portal.model.Layout updateLayout(
92          com.liferay.portal.model.Layout layout)
93          throws com.liferay.portal.SystemException;
94  
95      public com.liferay.portal.model.Layout updateLayout(
96          com.liferay.portal.model.Layout layout, boolean merge)
97          throws 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         throws com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException;
105 
106     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
107         boolean privateLayout, long parentLayoutId,
108         java.util.Map<java.util.Locale, String> localeNamesMap,
109         java.util.Map<java.util.Locale, String> localeTitlesMap,
110         java.lang.String description, java.lang.String type, boolean hidden,
111         java.lang.String friendlyURL)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
116         boolean privateLayout, long parentLayoutId, java.lang.String name,
117         java.lang.String title, java.lang.String description,
118         java.lang.String type, boolean hidden, java.lang.String friendlyURL,
119         long dlFolderId)
120         throws com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException;
122 
123     public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
124         boolean privateLayout, long parentLayoutId,
125         java.util.Map<java.util.Locale, String> localeNamesMap,
126         java.util.Map<java.util.Locale, String> localeTitlesMap,
127         java.lang.String description, java.lang.String type, boolean hidden,
128         java.lang.String friendlyURL, long dlFolderId)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException;
131 
132     public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException;
135 
136     public void deleteLayout(com.liferay.portal.model.Layout layout,
137         boolean updateLayoutSet)
138         throws com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public void deleteLayouts(long groupId, boolean privateLayout)
142         throws com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException;
144 
145     public byte[] exportLayouts(long groupId, boolean privateLayout,
146         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
147         java.util.Date endDate)
148         throws com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException;
150 
151     public byte[] exportLayouts(long groupId, boolean privateLayout,
152         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
153         java.util.Date startDate, java.util.Date endDate)
154         throws com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException;
156 
157     public com.liferay.portal.kernel.io.FileCacheOutputStream exportLayoutsAsStream(
158         long groupId, boolean privateLayout, long[] layoutIds,
159         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
160         java.util.Date endDate)
161         throws com.liferay.portal.PortalException,
162             com.liferay.portal.SystemException;
163 
164     public byte[] exportPortletInfo(long plid, long groupId,
165         java.lang.String portletId,
166         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
167         java.util.Date endDate)
168         throws com.liferay.portal.PortalException,
169             com.liferay.portal.SystemException;
170 
171     public com.liferay.portal.kernel.io.FileCacheOutputStream exportPortletInfoAsStream(
172         long plid, long groupId, java.lang.String portletId,
173         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
174         java.util.Date endDate)
175         throws com.liferay.portal.PortalException,
176             com.liferay.portal.SystemException;
177 
178     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179     public long getDefaultPlid(long groupId)
180         throws com.liferay.portal.SystemException;
181 
182     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183     public long getDefaultPlid(long groupId, boolean privateLayout)
184         throws com.liferay.portal.SystemException;
185 
186     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187     public long getDefaultPlid(long groupId, boolean privateLayout,
188         java.lang.String portletId) throws com.liferay.portal.SystemException;
189 
190     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191     public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
192         throws com.liferay.portal.PortalException,
193             com.liferay.portal.SystemException;
194 
195     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196     public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
197         boolean privateLayout, java.lang.String friendlyURL)
198         throws com.liferay.portal.PortalException,
199             com.liferay.portal.SystemException;
200 
201     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202     public com.liferay.portal.model.Layout getLayout(long groupId,
203         boolean privateLayout, long layoutId)
204         throws com.liferay.portal.PortalException,
205             com.liferay.portal.SystemException;
206 
207     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208     public com.liferay.portal.model.Layout getLayoutByIconImageId(
209         long iconImageId)
210         throws com.liferay.portal.PortalException,
211             com.liferay.portal.SystemException;
212 
213     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
215         long groupId, boolean privateLayout)
216         throws com.liferay.portal.SystemException;
217 
218     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
220         long groupId, boolean privateLayout, long parentLayoutId)
221         throws com.liferay.portal.SystemException;
222 
223     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
224     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
225         long groupId, boolean privateLayout, java.lang.String type)
226         throws com.liferay.portal.SystemException;
227 
228     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
230         long groupId, boolean privateLayout, long parentLayoutId, int start,
231         int end) throws com.liferay.portal.SystemException;
232 
233     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
234     public java.util.List<com.liferay.portal.model.Layout> getLayouts(
235         long groupId, boolean privateLayout, long[] layoutIds)
236         throws com.liferay.portal.PortalException,
237             com.liferay.portal.SystemException;
238 
239     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240     public com.liferay.portal.model.LayoutReference[] getLayouts(
241         long companyId, java.lang.String portletId, java.lang.String prefsKey,
242         java.lang.String prefsValue) throws com.liferay.portal.SystemException;
243 
244     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245     public long getNextLayoutId(long groupId, boolean privateLayout)
246         throws com.liferay.portal.SystemException;
247 
248     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249     public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
250         throws com.liferay.portal.SystemException;
251 
252     public void importLayouts(long userId, long groupId, boolean privateLayout,
253         java.util.Map<String, String[]> parameterMap, java.io.File file)
254         throws com.liferay.portal.PortalException,
255             com.liferay.portal.SystemException;
256 
257     public void importLayouts(long userId, long groupId, boolean privateLayout,
258         java.util.Map<String, String[]> parameterMap, byte[] bytes)
259         throws com.liferay.portal.PortalException,
260             com.liferay.portal.SystemException;
261 
262     public void importLayouts(long userId, long groupId, boolean privateLayout,
263         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
264         throws com.liferay.portal.PortalException,
265             com.liferay.portal.SystemException;
266 
267     public void importPortletInfo(long userId, long plid, long groupId,
268         java.lang.String portletId,
269         java.util.Map<String, String[]> parameterMap, java.io.File file)
270         throws com.liferay.portal.PortalException,
271             com.liferay.portal.SystemException;
272 
273     public void importPortletInfo(long userId, long plid, long groupId,
274         java.lang.String portletId,
275         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
276         throws com.liferay.portal.PortalException,
277             com.liferay.portal.SystemException;
278 
279     public void setLayouts(long groupId, boolean privateLayout,
280         long parentLayoutId, long[] layoutIds)
281         throws com.liferay.portal.PortalException,
282             com.liferay.portal.SystemException;
283 
284     public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
285         java.lang.String friendlyURL)
286         throws com.liferay.portal.PortalException,
287             com.liferay.portal.SystemException;
288 
289     public com.liferay.portal.model.Layout updateLayout(long groupId,
290         boolean privateLayout, long layoutId, long parentLayoutId,
291         java.util.Map<java.util.Locale, String> localeNamesMap,
292         java.util.Map<java.util.Locale, String> localeTitlesMap,
293         java.lang.String description, java.lang.String type, boolean hidden,
294         java.lang.String friendlyURL)
295         throws com.liferay.portal.PortalException,
296             com.liferay.portal.SystemException;
297 
298     public com.liferay.portal.model.Layout updateLayout(long groupId,
299         boolean privateLayout, long layoutId, long parentLayoutId,
300         java.util.Map<java.util.Locale, String> localeNamesMap,
301         java.util.Map<java.util.Locale, String> localeTitlesMap,
302         java.lang.String description, java.lang.String type, boolean hidden,
303         java.lang.String friendlyURL, java.lang.Boolean iconImage,
304         byte[] iconBytes)
305         throws com.liferay.portal.PortalException,
306             com.liferay.portal.SystemException;
307 
308     public com.liferay.portal.model.Layout updateLayout(long groupId,
309         boolean privateLayout, long layoutId, java.lang.String typeSettings)
310         throws com.liferay.portal.PortalException,
311             com.liferay.portal.SystemException;
312 
313     public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
314         boolean privateLayout, long layoutId, java.lang.String themeId,
315         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
316         throws com.liferay.portal.PortalException,
317             com.liferay.portal.SystemException;
318 
319     public com.liferay.portal.model.Layout updateName(long plid,
320         java.lang.String name, java.lang.String languageId)
321         throws com.liferay.portal.PortalException,
322             com.liferay.portal.SystemException;
323 
324     public com.liferay.portal.model.Layout updateName(long groupId,
325         boolean privateLayout, long layoutId, java.lang.String name,
326         java.lang.String languageId)
327         throws com.liferay.portal.PortalException,
328             com.liferay.portal.SystemException;
329 
330     public com.liferay.portal.model.Layout updateName(
331         com.liferay.portal.model.Layout layout, java.lang.String name,
332         java.lang.String languageId)
333         throws com.liferay.portal.PortalException,
334             com.liferay.portal.SystemException;
335 
336     public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
337         long parentPlid)
338         throws com.liferay.portal.PortalException,
339             com.liferay.portal.SystemException;
340 
341     public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
342         boolean privateLayout, long layoutId, long parentLayoutId)
343         throws com.liferay.portal.PortalException,
344             com.liferay.portal.SystemException;
345 
346     public com.liferay.portal.model.Layout updatePriority(long plid,
347         int priority)
348         throws com.liferay.portal.PortalException,
349             com.liferay.portal.SystemException;
350 
351     public com.liferay.portal.model.Layout updatePriority(long groupId,
352         boolean privateLayout, long layoutId, int priority)
353         throws com.liferay.portal.PortalException,
354             com.liferay.portal.SystemException;
355 
356     public com.liferay.portal.model.Layout updatePriority(
357         com.liferay.portal.model.Layout layout, int priority)
358         throws com.liferay.portal.SystemException;
359 }