001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * <p>
025     * This interface defines the service. The default implementation is
026     * {@link
027     * com.liferay.portal.service.impl.LayoutLocalServiceImpl}.
028     * Modify methods in that class and rerun ServiceBuilder to populate this class
029     * and all other generated classes.
030     * </p>
031     *
032     * <p>
033     * 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.
034     * </p>
035     *
036     * @author    Brian Wing Shun Chan
037     * @see       LayoutLocalServiceUtil
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface LayoutLocalService {
043            public com.liferay.portal.model.Layout addLayout(
044                    com.liferay.portal.model.Layout layout)
045                    throws com.liferay.portal.kernel.exception.SystemException;
046    
047            public com.liferay.portal.model.Layout createLayout(long plid);
048    
049            public void deleteLayout(long plid)
050                    throws com.liferay.portal.kernel.exception.PortalException,
051                            com.liferay.portal.kernel.exception.SystemException;
052    
053            public void deleteLayout(com.liferay.portal.model.Layout layout)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            @SuppressWarnings("unchecked")
057            public java.util.List dynamicQuery(
058                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            @SuppressWarnings("unchecked")
062            public java.util.List dynamicQuery(
063                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
064                    int end) throws com.liferay.portal.kernel.exception.SystemException;
065    
066            @SuppressWarnings("unchecked")
067            public java.util.List dynamicQuery(
068                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
069                    int end,
070                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
071                    throws com.liferay.portal.kernel.exception.SystemException;
072    
073            public long dynamicQueryCount(
074                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
075                    throws com.liferay.portal.kernel.exception.SystemException;
076    
077            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
078            public com.liferay.portal.model.Layout getLayout(long plid)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
083            public com.liferay.portal.model.Layout getLayoutByUuidAndGroupId(
084                    java.lang.String uuid, long groupId)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
089            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
090                    int start, int end)
091                    throws com.liferay.portal.kernel.exception.SystemException;
092    
093            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
094            public int getLayoutsCount()
095                    throws com.liferay.portal.kernel.exception.SystemException;
096    
097            public com.liferay.portal.model.Layout updateLayout(
098                    com.liferay.portal.model.Layout layout)
099                    throws com.liferay.portal.kernel.exception.SystemException;
100    
101            public com.liferay.portal.model.Layout updateLayout(
102                    com.liferay.portal.model.Layout layout, boolean merge)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
106                    boolean privateLayout, long parentLayoutId,
107                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
108                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
109                    java.lang.String description, java.lang.String type, boolean hidden,
110                    java.lang.String friendlyURL, long dlFolderId,
111                    com.liferay.portal.service.ServiceContext serviceContext)
112                    throws com.liferay.portal.kernel.exception.PortalException,
113                            com.liferay.portal.kernel.exception.SystemException;
114    
115            public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
116                    boolean privateLayout, long parentLayoutId,
117                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
118                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
119                    java.lang.String description, java.lang.String type, boolean hidden,
120                    java.lang.String friendlyURL,
121                    com.liferay.portal.service.ServiceContext serviceContext)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException;
124    
125            public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
126                    boolean privateLayout, long parentLayoutId, java.lang.String name,
127                    java.lang.String title, java.lang.String description,
128                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
129                    long dlFolderId,
130                    com.liferay.portal.service.ServiceContext serviceContext)
131                    throws com.liferay.portal.kernel.exception.PortalException,
132                            com.liferay.portal.kernel.exception.SystemException;
133    
134            public com.liferay.portal.model.Layout addLayout(long userId, long groupId,
135                    boolean privateLayout, long parentLayoutId, java.lang.String name,
136                    java.lang.String title, java.lang.String description,
137                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
138                    com.liferay.portal.service.ServiceContext serviceContext)
139                    throws com.liferay.portal.kernel.exception.PortalException,
140                            com.liferay.portal.kernel.exception.SystemException;
141    
142            public void deleteLayout(com.liferay.portal.model.Layout layout,
143                    boolean updateLayoutSet)
144                    throws com.liferay.portal.kernel.exception.PortalException,
145                            com.liferay.portal.kernel.exception.SystemException;
146    
147            public void deleteLayout(long groupId, boolean privateLayout, long layoutId)
148                    throws com.liferay.portal.kernel.exception.PortalException,
149                            com.liferay.portal.kernel.exception.SystemException;
150    
151            public void deleteLayouts(long groupId, boolean privateLayout)
152                    throws com.liferay.portal.kernel.exception.PortalException,
153                            com.liferay.portal.kernel.exception.SystemException;
154    
155            public byte[] exportLayouts(long groupId, boolean privateLayout,
156                    long[] layoutIds,
157                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
158                    java.util.Date startDate, java.util.Date endDate)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            public byte[] exportLayouts(long groupId, boolean privateLayout,
163                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
164                    java.util.Date startDate, java.util.Date endDate)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            public java.io.File exportLayoutsAsFile(long groupId,
169                    boolean privateLayout, long[] layoutIds,
170                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
171                    java.util.Date startDate, java.util.Date endDate)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            public byte[] exportPortletInfo(long plid, long groupId,
176                    java.lang.String portletId,
177                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
178                    java.util.Date startDate, java.util.Date endDate)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException;
181    
182            public java.io.File exportPortletInfoAsFile(long plid, long groupId,
183                    java.lang.String portletId,
184                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
185                    java.util.Date startDate, java.util.Date endDate)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public long getDefaultPlid(long groupId)
191                    throws com.liferay.portal.kernel.exception.SystemException;
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public long getDefaultPlid(long groupId, boolean privateLayout)
195                    throws com.liferay.portal.kernel.exception.SystemException;
196    
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public long getDefaultPlid(long groupId, boolean privateLayout,
199                    java.lang.String portletId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public com.liferay.portal.model.Layout getDLFolderLayout(long dlFolderId)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException;
207    
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId,
210                    boolean privateLayout, java.lang.String friendlyURL)
211                    throws com.liferay.portal.kernel.exception.PortalException,
212                            com.liferay.portal.kernel.exception.SystemException;
213    
214            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215            public com.liferay.portal.model.Layout getLayout(long groupId,
216                    boolean privateLayout, long layoutId)
217                    throws com.liferay.portal.kernel.exception.PortalException,
218                            com.liferay.portal.kernel.exception.SystemException;
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public com.liferay.portal.model.Layout getLayoutByIconImageId(
222                    long iconImageId)
223                    throws com.liferay.portal.kernel.exception.PortalException,
224                            com.liferay.portal.kernel.exception.SystemException;
225    
226            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
228                    long groupId, boolean privateLayout)
229                    throws com.liferay.portal.kernel.exception.SystemException;
230    
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
233                    long groupId, boolean privateLayout, long parentLayoutId)
234                    throws com.liferay.portal.kernel.exception.SystemException;
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
238                    long groupId, boolean privateLayout, long parentLayoutId, int start,
239                    int end) throws com.liferay.portal.kernel.exception.SystemException;
240    
241            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
242            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
243                    long groupId, boolean privateLayout, long[] layoutIds)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
249                    long groupId, boolean privateLayout, java.lang.String type)
250                    throws com.liferay.portal.kernel.exception.SystemException;
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public com.liferay.portal.model.LayoutReference[] getLayouts(
254                    long companyId, java.lang.String portletId,
255                    java.lang.String preferencesKey, java.lang.String preferencesValue)
256                    throws com.liferay.portal.kernel.exception.SystemException;
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public long getNextLayoutId(long groupId, boolean privateLayout)
260                    throws com.liferay.portal.kernel.exception.SystemException;
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts()
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public boolean hasLayouts(long groupId, boolean privateLayout,
268                    long parentLayoutId)
269                    throws com.liferay.portal.kernel.exception.SystemException;
270    
271            public void importLayouts(long userId, long groupId, boolean privateLayout,
272                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
273                    byte[] bytes)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void importLayouts(long userId, long groupId, boolean privateLayout,
278                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
279                    java.io.File file)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void importLayouts(long userId, long groupId, boolean privateLayout,
284                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
285                    java.io.InputStream is)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void importPortletInfo(long userId, long plid, long groupId,
290                    java.lang.String portletId,
291                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
292                    java.io.File file)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException;
295    
296            public void importPortletInfo(long userId, long plid, long groupId,
297                    java.lang.String portletId,
298                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
299                    java.io.InputStream is)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            public void setLayouts(long groupId, boolean privateLayout,
304                    long parentLayoutId, long[] layoutIds)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            public com.liferay.portal.model.Layout updateFriendlyURL(long plid,
309                    java.lang.String friendlyURL)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            public com.liferay.portal.model.Layout updateLayout(long groupId,
314                    boolean privateLayout, long layoutId, long parentLayoutId,
315                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
316                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
317                    java.lang.String description, java.lang.String type, boolean hidden,
318                    java.lang.String friendlyURL, java.lang.Boolean iconImage,
319                    byte[] iconBytes,
320                    com.liferay.portal.service.ServiceContext serviceContext)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException;
323    
324            public com.liferay.portal.model.Layout updateLayout(long groupId,
325                    boolean privateLayout, long layoutId, long parentLayoutId,
326                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
327                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
328                    java.lang.String description, java.lang.String type, boolean hidden,
329                    java.lang.String friendlyURL,
330                    com.liferay.portal.service.ServiceContext serviceContext)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException;
333    
334            public com.liferay.portal.model.Layout updateLayout(long groupId,
335                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException;
338    
339            public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
340                    boolean privateLayout, long layoutId, java.lang.String themeId,
341                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException;
344    
345            public com.liferay.portal.model.Layout updateName(
346                    com.liferay.portal.model.Layout layout, java.lang.String name,
347                    java.lang.String languageId)
348                    throws com.liferay.portal.kernel.exception.PortalException,
349                            com.liferay.portal.kernel.exception.SystemException;
350    
351            public com.liferay.portal.model.Layout updateName(long groupId,
352                    boolean privateLayout, long layoutId, java.lang.String name,
353                    java.lang.String languageId)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            public com.liferay.portal.model.Layout updateName(long plid,
358                    java.lang.String name, java.lang.String languageId)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException;
361    
362            public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
363                    boolean privateLayout, long layoutId, long parentLayoutId)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException;
366    
367            public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
368                    long parentPlid)
369                    throws com.liferay.portal.kernel.exception.PortalException,
370                            com.liferay.portal.kernel.exception.SystemException;
371    
372            public com.liferay.portal.model.Layout updatePriority(
373                    com.liferay.portal.model.Layout layout, int priority)
374                    throws com.liferay.portal.kernel.exception.SystemException;
375    
376            public com.liferay.portal.model.Layout updatePriority(long groupId,
377                    boolean privateLayout, long layoutId, int priority)
378                    throws com.liferay.portal.kernel.exception.PortalException,
379                            com.liferay.portal.kernel.exception.SystemException;
380    
381            public com.liferay.portal.model.Layout updatePriority(long plid,
382                    int priority)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException;
385    }