001    /**
002     * Copyright (c) 2000-2013 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    /**
018     * <p>
019     * This class is a wrapper for {@link LayoutService}.
020     * </p>
021     *
022     * @author    Brian Wing Shun Chan
023     * @see       LayoutService
024     * @generated
025     */
026    public class LayoutServiceWrapper implements LayoutService,
027            ServiceWrapper<LayoutService> {
028            public LayoutServiceWrapper(LayoutService layoutService) {
029                    _layoutService = layoutService;
030            }
031    
032            /**
033            * Returns the Spring bean ID for this bean.
034            *
035            * @return the Spring bean ID for this bean
036            */
037            public java.lang.String getBeanIdentifier() {
038                    return _layoutService.getBeanIdentifier();
039            }
040    
041            /**
042            * Sets the Spring bean ID for this bean.
043            *
044            * @param beanIdentifier the Spring bean ID for this bean
045            */
046            public void setBeanIdentifier(java.lang.String beanIdentifier) {
047                    _layoutService.setBeanIdentifier(beanIdentifier);
048            }
049    
050            /**
051            * Adds a layout with additional parameters.
052            *
053            * <p>
054            * This method handles the creation of the layout including its resources,
055            * metadata, and internal data structures. It is not necessary to make
056            * subsequent calls to any methods to setup default groups, resources, ...
057            * etc.
058            * </p>
059            *
060            * @param groupId the primary key of the group
061            * @param privateLayout whether the layout is private to the group
062            * @param parentLayoutId the primary key of the parent layout (optionally
063            {@link
064            com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
065            * @param localeNamesMap the layout's locales and localized names
066            * @param localeTitlesMap the layout's locales and localized titles
067            * @param descriptionMap the layout's locales and localized descriptions
068            * @param keywordsMap the layout's locales and localized keywords
069            * @param robotsMap the layout's locales and localized robots
070            * @param type the layout's type (optionally {@link
071            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The
072            possible types can be found in {@link
073            com.liferay.portal.model.LayoutConstants}.
074            * @param hidden whether the layout is hidden
075            * @param friendlyURL the layout's friendly URL (optionally {@link
076            com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}
077            or {@link
078            com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}).
079            The default values can be overridden in
080            <code>portal-ext.properties</code> by specifying new values for
081            the corresponding properties defined in {@link
082            com.liferay.portal.util.PropsValues}. To see how the URL is
083            normalized when accessed see {@link
084            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
085            String)}.
086            * @param serviceContext the service context to be applied. Must set the
087            UUID for the layout. Can set the creation date, modification date
088            and the expando bridge attributes for the layout. For layouts
089            that belong to a layout set prototype, an attribute named
090            'layoutUpdateable' can be used to specify whether site
091            administrators can modify this page within their site.
092            * @return the layout
093            * @throws PortalException if a group with the primary key could not be
094            found, if the group did not have permission to manage the layouts
095            involved, or if layout values were invalid
096            * @throws SystemException if a system exception occurred
097            */
098            public com.liferay.portal.model.Layout addLayout(long groupId,
099                    boolean privateLayout, long parentLayoutId,
100                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
101                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
102                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
103                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
104                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
105                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
106                    com.liferay.portal.service.ServiceContext serviceContext)
107                    throws com.liferay.portal.kernel.exception.PortalException,
108                            com.liferay.portal.kernel.exception.SystemException {
109                    return _layoutService.addLayout(groupId, privateLayout, parentLayoutId,
110                            localeNamesMap, localeTitlesMap, descriptionMap, keywordsMap,
111                            robotsMap, type, hidden, friendlyURL, serviceContext);
112            }
113    
114            /**
115            * Adds a layout with single entry maps for name, title, and description to
116            * the default locale.
117            *
118            * <p>
119            * This method handles the creation of the layout including its resources,
120            * metadata, and internal data structures. It is not necessary to make
121            * subsequent calls to any methods to setup default groups, resources, ...
122            * etc.
123            * </p>
124            *
125            * @param groupId the primary key of the group
126            * @param privateLayout whether the layout is private to the group
127            * @param parentLayoutId the primary key of the parent layout (optionally
128            {@link
129            com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
130            * @param name Map the layout's locales and localized names
131            * @param title Map the layout's locales and localized titles
132            * @param description Map the layout's locales and localized descriptions
133            * @param type the layout's type (optionally {@link
134            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The
135            possible types can be found in {@link
136            com.liferay.portal.model.LayoutConstants}.
137            * @param hidden whether the layout is hidden
138            * @param friendlyURL the layout's friendly URL (optionally {@link
139            com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}
140            or {@link
141            com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}).
142            The default values can be overridden in
143            <code>portal-ext.properties</code> by specifying new values for
144            the corresponding properties defined in {@link
145            com.liferay.portal.util.PropsValues}. To see how the URL is
146            normalized when accessed see {@link
147            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
148            String)}.
149            * @param serviceContext the service context to be applied. Must set the
150            UUID for the layout. Can specify the creation date, modification
151            date and the expando bridge attributes for the layout. For
152            layouts that belong to a layout set prototype, an attribute named
153            'layoutUpdateable' can be used to specify whether site
154            administrators can modify this page within their site.
155            * @return the layout
156            * @throws PortalException if a group with the primary key could not be
157            found, if the group did not have permission to manage the layouts
158            involved, or if layout values were invalid
159            * @throws SystemException if a system exception occurred
160            */
161            public com.liferay.portal.model.Layout addLayout(long groupId,
162                    boolean privateLayout, long parentLayoutId, java.lang.String name,
163                    java.lang.String title, java.lang.String description,
164                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
165                    com.liferay.portal.service.ServiceContext serviceContext)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException {
168                    return _layoutService.addLayout(groupId, privateLayout, parentLayoutId,
169                            name, title, description, type, hidden, friendlyURL, serviceContext);
170            }
171    
172            /**
173            * Deletes the layout with the primary key, also deleting the layout's child
174            * layouts, and associated resources.
175            *
176            * @param groupId the primary key of the group
177            * @param privateLayout whether the layout is private to the group
178            * @param layoutId the primary key of the layout
179            * @param serviceContext the service context to be applied
180            * @throws PortalException if the user did not have permission to delete the
181            layout, if a matching layout could not be found , or if some
182            other portal exception occurred
183            * @throws SystemException if a system exception occurred
184            */
185            public void deleteLayout(long groupId, boolean privateLayout,
186                    long layoutId, com.liferay.portal.service.ServiceContext serviceContext)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException {
189                    _layoutService.deleteLayout(groupId, privateLayout, layoutId,
190                            serviceContext);
191            }
192    
193            /**
194            * Deletes the layout with the plid, also deleting the layout's child
195            * layouts, and associated resources.
196            *
197            * @param plid the primary key of the layout
198            * @param serviceContext the service context to be applied
199            * @throws PortalException if the user did not have permission to delete the
200            layout, if a layout with the primary key could not be found , or
201            if some other portal exception occurred
202            * @throws SystemException if a system exception occurred
203            */
204            public void deleteLayout(long plid,
205                    com.liferay.portal.service.ServiceContext serviceContext)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    _layoutService.deleteLayout(plid, serviceContext);
209            }
210    
211            /**
212            * Exports the layouts that match the primary keys and the criteria as a
213            * byte array.
214            *
215            * @param groupId the primary key of the group
216            * @param privateLayout whether the layout is private to the group
217            * @param layoutIds the primary keys of the layouts to be exported
218            * @param parameterMap the mapping of parameters indicating which
219            information to export. For information on the keys used in the
220            map see {@link
221            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
222            * @param startDate the export's start date
223            * @param endDate the export's end date
224            * @return the layouts as a byte array
225            * @throws PortalException if a group or any layout with the primary key
226            could not be found, if the group did not have permission to
227            manage the layouts, or if some other portal exception occurred
228            * @throws SystemException if a system exception occurred
229            */
230            public byte[] exportLayouts(long groupId, boolean privateLayout,
231                    long[] layoutIds,
232                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
233                    java.util.Date startDate, java.util.Date endDate)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException {
236                    return _layoutService.exportLayouts(groupId, privateLayout, layoutIds,
237                            parameterMap, startDate, endDate);
238            }
239    
240            /**
241            * Exports all layouts that match the criteria as a byte array.
242            *
243            * @param groupId the primary key of the group
244            * @param privateLayout whether the layout is private to the group
245            * @param parameterMap the mapping of parameters indicating which
246            information to export. For information on the keys used in the
247            map see {@link
248            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
249            * @param startDate the export's start date
250            * @param endDate the export's end date
251            * @return the layout as a byte array
252            * @throws PortalException if a group with the primary key could not be
253            found, if the group did not have permission to manage the
254            layouts, or if some other portal exception occurred
255            * @throws SystemException if a system exception occurred
256            */
257            public byte[] exportLayouts(long groupId, boolean privateLayout,
258                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
259                    java.util.Date startDate, java.util.Date endDate)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return _layoutService.exportLayouts(groupId, privateLayout,
263                            parameterMap, startDate, endDate);
264            }
265    
266            /**
267            * Exports all layouts that match the primary keys and criteria as a file.
268            *
269            * @param groupId the primary key of the group
270            * @param privateLayout whether the layout is private to the group
271            * @param layoutIds the primary keys of the layouts to be exported
272            (optionally <code>null</code>)
273            * @param parameterMap the mapping of parameters indicating which
274            information to export. For information on the keys used in the
275            map see {@link
276            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
277            * @param startDate the export's start date
278            * @param endDate the export's end date
279            * @return the layouts as a File
280            * @throws PortalException if a group or any layout with the primary key
281            could not be found, it the group did not have permission to
282            manage the layouts, or if some other portal exception occurred
283            * @throws SystemException if a system exception occurred
284            */
285            public java.io.File exportLayoutsAsFile(long groupId,
286                    boolean privateLayout, long[] layoutIds,
287                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
288                    java.util.Date startDate, java.util.Date endDate)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    return _layoutService.exportLayoutsAsFile(groupId, privateLayout,
292                            layoutIds, parameterMap, startDate, endDate);
293            }
294    
295            /**
296            * Exports the portlet information (categories, permissions, ... etc.) as a
297            * byte array.
298            *
299            * @param plid the primary key of the layout
300            * @param groupId the primary key of the group
301            * @param portletId the primary key of the portlet
302            * @param parameterMap the mapping of parameters indicating which
303            information to export. For information on the keys used in the
304            map see {@link
305            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
306            * @param startDate the export's start date
307            * @param endDate the export's end date
308            * @return the portlet information as a byte array
309            * @throws PortalException if a layout, group, or portlet with the primary
310            key could not be found, if the group did not have permission to
311            manage the layouts involved, or if some other portal exception
312            occurred
313            * @throws SystemException if a system exception occurred
314            */
315            public byte[] exportPortletInfo(long plid, long groupId,
316                    java.lang.String portletId,
317                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
318                    java.util.Date startDate, java.util.Date endDate)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    return _layoutService.exportPortletInfo(plid, groupId, portletId,
322                            parameterMap, startDate, endDate);
323            }
324    
325            /**
326            * Exports the portlet information (categories, permissions, ... etc.) as a
327            * file.
328            *
329            * @param plid the primary key of the layout
330            * @param groupId the primary key of the group
331            * @param portletId the primary key of the portlet
332            * @param parameterMap the mapping of parameters indicating which
333            information to export. For information on the keys used in the
334            map see {@link
335            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
336            * @param startDate the export's start date
337            * @param endDate the export's end date
338            * @return the portlet information as a file
339            * @throws PortalException if a layout, group, or portlet with the primary
340            key could not be found, it the group did not have permission to
341            manage the layouts involved, or if some other portal exception
342            occurred
343            * @throws SystemException if a system exception occurred
344            */
345            public java.io.File exportPortletInfoAsFile(long plid, long groupId,
346                    java.lang.String portletId,
347                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
348                    java.util.Date startDate, java.util.Date endDate)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException {
351                    return _layoutService.exportPortletInfoAsFile(plid, groupId, portletId,
352                            parameterMap, startDate, endDate);
353            }
354    
355            /**
356            * Returns all the ancestor layouts of the layout.
357            *
358            * @param plid the primary key of the layout
359            * @return the ancestor layouts of the layout
360            * @throws PortalException if a matching layout could not be found or if a
361            portal exception occurred
362            * @throws SystemException if a system exception occurred
363            */
364            public java.util.List<com.liferay.portal.model.Layout> getAncestorLayouts(
365                    long plid)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return _layoutService.getAncestorLayouts(plid);
369            }
370    
371            /**
372            * Returns the primary key of the default layout for the group.
373            *
374            * @param groupId the primary key of the group
375            * @param scopeGroupId the primary key of the scope group. See {@link
376            com.liferay.portal.service.ServiceContext#getScopeGroupId()}.
377            * @param privateLayout whether the layout is private to the group
378            * @param portletId the primary key of the portlet
379            * @return Returns the primary key of the default layout group; {@link
380            com.liferay.portal.model.LayoutConstants#DEFAULT_PLID} otherwise
381            * @throws PortalException if a group, layout, or portlet with the primary
382            key could not be found
383            * @throws SystemException if a system exception occurred
384            */
385            public long getDefaultPlid(long groupId, long scopeGroupId,
386                    boolean privateLayout, java.lang.String portletId)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    return _layoutService.getDefaultPlid(groupId, scopeGroupId,
390                            privateLayout, portletId);
391            }
392    
393            public long getDefaultPlid(long groupId, long scopeGroupId,
394                    java.lang.String portletId)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException {
397                    return _layoutService.getDefaultPlid(groupId, scopeGroupId, portletId);
398            }
399    
400            /**
401            * Returns the layout matching the UUID, group, and privacy.
402            *
403            * @param uuid the layout's UUID
404            * @param groupId the primary key of the group
405            * @param privateLayout whether the layout is private to the group
406            * @return the matching layout
407            * @throws PortalException if a matching layout could not be found, if the
408            user did not have permission to view the layout, or if some other
409            portal exception occurred
410            * @throws SystemException if a system exception occurred
411            */
412            public com.liferay.portal.model.Layout getLayoutByUuidAndGroupId(
413                    java.lang.String uuid, long groupId, boolean privateLayout)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException {
416                    return _layoutService.getLayoutByUuidAndGroupId(uuid, groupId,
417                            privateLayout);
418            }
419    
420            /**
421            * Returns the name of the layout.
422            *
423            * @param groupId the primary key of the group
424            * @param privateLayout whether the layout is private to the group
425            * @param layoutId the primary key of the layout
426            * @param languageId the primary key of the language. For more information
427            See {@link java.util.Locale}.
428            * @return the layout's name
429            * @throws PortalException if a matching layout could not be found
430            * @throws SystemException if a system exception occurred
431            */
432            public java.lang.String getLayoutName(long groupId, boolean privateLayout,
433                    long layoutId, java.lang.String languageId)
434                    throws com.liferay.portal.kernel.exception.PortalException,
435                            com.liferay.portal.kernel.exception.SystemException {
436                    return _layoutService.getLayoutName(groupId, privateLayout, layoutId,
437                            languageId);
438            }
439    
440            /**
441            * Returns the layout references for all the layouts that belong to the
442            * company and belong to the portlet that matches the preferences.
443            *
444            * @param companyId the primary key of the company
445            * @param portletId the primary key of the portlet
446            * @param preferencesKey the portlet's preference key
447            * @param preferencesValue the portlet's preference value
448            * @return the layout references of the matching layouts
449            * @throws SystemException if a system exception occurred
450            */
451            public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
452                    long companyId, java.lang.String portletId,
453                    java.lang.String preferencesKey, java.lang.String preferencesValue)
454                    throws com.liferay.portal.kernel.exception.SystemException {
455                    return _layoutService.getLayoutReferences(companyId, portletId,
456                            preferencesKey, preferencesValue);
457            }
458    
459            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
460                    long groupId, boolean privateLayout)
461                    throws com.liferay.portal.kernel.exception.SystemException {
462                    return _layoutService.getLayouts(groupId, privateLayout);
463            }
464    
465            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
466                    long groupId, boolean privateLayout, long parentLayoutId)
467                    throws com.liferay.portal.kernel.exception.SystemException {
468                    return _layoutService.getLayouts(groupId, privateLayout, parentLayoutId);
469            }
470    
471            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
472                    long groupId, boolean privateLayout, long parentLayoutId,
473                    boolean incomplete, int start, int end)
474                    throws com.liferay.portal.kernel.exception.PortalException,
475                            com.liferay.portal.kernel.exception.SystemException {
476                    return _layoutService.getLayouts(groupId, privateLayout,
477                            parentLayoutId, incomplete, start, end);
478            }
479    
480            /**
481            * Imports the layouts from the byte array.
482            *
483            * @param groupId the primary key of the group
484            * @param privateLayout whether the layout is private to the group
485            * @param parameterMap the mapping of parameters indicating which
486            information will be imported. For information on the keys used in
487            the map see {@link
488            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
489            * @param bytes the byte array with the data
490            * @throws PortalException if a group with the primary key could not be
491            found, if the group did not have permission to manage the
492            layouts, or if some other portal exception occurred
493            * @throws SystemException if a system exception occurred
494            * @see com.liferay.portal.lar.LayoutImporter
495            */
496            public void importLayouts(long groupId, boolean privateLayout,
497                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
498                    byte[] bytes)
499                    throws com.liferay.portal.kernel.exception.PortalException,
500                            com.liferay.portal.kernel.exception.SystemException {
501                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, bytes);
502            }
503    
504            /**
505            * Imports the layouts from the file.
506            *
507            * @param groupId the primary key of the group
508            * @param privateLayout whether the layout is private to the group
509            * @param parameterMap the mapping of parameters indicating which
510            information will be imported. For information on the keys used in
511            the map see {@link
512            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
513            * @param file the LAR file with the data
514            * @throws PortalException if a group with the primary key could not be
515            found, if the group did not have permission to manage the layouts
516            and publish, or if some other portal exception occurred
517            * @throws SystemException if a system exception occurred
518            * @see com.liferay.portal.lar.LayoutImporter
519            */
520            public void importLayouts(long groupId, boolean privateLayout,
521                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
522                    java.io.File file)
523                    throws com.liferay.portal.kernel.exception.PortalException,
524                            com.liferay.portal.kernel.exception.SystemException {
525                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, file);
526            }
527    
528            /**
529            * Imports the layouts from the input stream.
530            *
531            * @param groupId the primary key of the group
532            * @param privateLayout whether the layout is private to the group
533            * @param parameterMap the mapping of parameters indicating which
534            information will be imported. For information on the keys used in
535            the map see {@link
536            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
537            * @param is the input stream
538            * @throws PortalException if a group with the primary key could not be
539            found, if the group did not have permission to manage the
540            layouts, or if some other portal exception occurred
541            * @throws SystemException if a system exception occurred
542            * @see com.liferay.portal.lar.LayoutImporter
543            */
544            public void importLayouts(long groupId, boolean privateLayout,
545                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
546                    java.io.InputStream is)
547                    throws com.liferay.portal.kernel.exception.PortalException,
548                            com.liferay.portal.kernel.exception.SystemException {
549                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, is);
550            }
551    
552            /**
553            * Imports the portlet information (categories, permissions, ... etc.) from
554            * the file.
555            *
556            * @param plid the primary key of the layout
557            * @param groupId the primary key of the group
558            * @param portletId the primary key of the portlet
559            * @param parameterMap the mapping of parameters indicating which
560            information will be imported. For information on the keys used in
561            the map see {@link
562            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
563            * @param file the LAR file with the data
564            * @throws PortalException if a group, layout, or portlet with the primary
565            key could not be found, or if the group did not have permission
566            to manage the layouts
567            * @throws SystemException if a system exception occurred
568            */
569            public void importPortletInfo(long plid, long groupId,
570                    java.lang.String portletId,
571                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
572                    java.io.File file)
573                    throws com.liferay.portal.kernel.exception.PortalException,
574                            com.liferay.portal.kernel.exception.SystemException {
575                    _layoutService.importPortletInfo(plid, groupId, portletId,
576                            parameterMap, file);
577            }
578    
579            /**
580            * Imports the portlet information (categories, permissions, ... etc.) from
581            * the input stream.
582            *
583            * @param plid the primary key of the layout
584            * @param groupId the primary key of the group
585            * @param portletId the primary key of the portlet
586            * @param parameterMap the mapping of parameters indicating which
587            information will be imported. For information on the keys used in
588            the map see {@link
589            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
590            * @param is the input stream
591            * @throws PortalException if a group, portlet, or layout with the primary
592            key could not be found or if the group did not have permission to
593            manage the layouts
594            * @throws SystemException if a system exception occurred
595            */
596            public void importPortletInfo(long plid, long groupId,
597                    java.lang.String portletId,
598                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
599                    java.io.InputStream is)
600                    throws com.liferay.portal.kernel.exception.PortalException,
601                            com.liferay.portal.kernel.exception.SystemException {
602                    _layoutService.importPortletInfo(plid, groupId, portletId,
603                            parameterMap, is);
604            }
605    
606            /**
607            * Schedules a range of layouts to be published.
608            *
609            * @param sourceGroupId the primary key of the source group
610            * @param targetGroupId the primary key of the target group
611            * @param privateLayout whether the layout is private to the group
612            * @param layoutIdMap the layouts considered for publishing, specified by
613            the layout IDs and booleans indicating whether they have children
614            * @param parameterMap the mapping of parameters indicating which
615            information will be used. See {@link
616            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}
617            * @param scope the scope of the pages. It can be <code>all-pages</code> or
618            <code>selected-pages</code>.
619            * @param startDate the start date
620            * @param endDate the end date
621            * @param groupName the group name (optionally {@link
622            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
623            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
624            * @param cronText the cron text. See {@link
625            com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText}
626            * @param schedulerStartDate the scheduler start date
627            * @param schedulerEndDate the scheduler end date
628            * @param description the scheduler description
629            * @throws PortalException if the group did not have permission to manage
630            and publish
631            * @throws SystemException if a system exception occurred
632            */
633            public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
634                    boolean privateLayout,
635                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
636                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
637                    java.lang.String scope, java.util.Date startDate,
638                    java.util.Date endDate, java.lang.String groupName,
639                    java.lang.String cronText, java.util.Date schedulerStartDate,
640                    java.util.Date schedulerEndDate, java.lang.String description)
641                    throws com.liferay.portal.kernel.exception.PortalException,
642                            com.liferay.portal.kernel.exception.SystemException {
643                    _layoutService.schedulePublishToLive(sourceGroupId, targetGroupId,
644                            privateLayout, layoutIdMap, parameterMap, scope, startDate,
645                            endDate, groupName, cronText, schedulerStartDate, schedulerEndDate,
646                            description);
647            }
648    
649            /**
650            * Schedules a range of layouts to be stored.
651            *
652            * @param sourceGroupId the primary key of the source group
653            * @param privateLayout whether the layout is private to the group
654            * @param layoutIdMap the layouts considered for publishing, specified by
655            the layout IDs and booleans indicating whether they have children
656            * @param parameterMap the mapping of parameters indicating which
657            information will be used. See {@link
658            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}
659            * @param remoteAddress the remote address
660            * @param remotePort the remote port
661            * @param remotePathContext the remote path context
662            * @param secureConnection whether the connection is secure
663            * @param remoteGroupId the primary key of the remote group
664            * @param remotePrivateLayout whether remote group's layout is private
665            * @param startDate the start date
666            * @param endDate the end date
667            * @param groupName the group name. Optionally {@link
668            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
669            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
670            * @param cronText the cron text. See {@link
671            com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText}
672            * @param schedulerStartDate the scheduler start date
673            * @param schedulerEndDate the scheduler end date
674            * @param description the scheduler description
675            * @throws PortalException if a group with the source group primary key was
676            not found or if the group did not have permission to publish
677            * @throws SystemException if a system exception occurred
678            */
679            public void schedulePublishToRemote(long sourceGroupId,
680                    boolean privateLayout,
681                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
682                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
683                    java.lang.String remoteAddress, int remotePort,
684                    java.lang.String remotePathContext, boolean secureConnection,
685                    long remoteGroupId, boolean remotePrivateLayout,
686                    java.util.Date startDate, java.util.Date endDate,
687                    java.lang.String groupName, java.lang.String cronText,
688                    java.util.Date schedulerStartDate, java.util.Date schedulerEndDate,
689                    java.lang.String description)
690                    throws com.liferay.portal.kernel.exception.PortalException,
691                            com.liferay.portal.kernel.exception.SystemException {
692                    _layoutService.schedulePublishToRemote(sourceGroupId, privateLayout,
693                            layoutIdMap, parameterMap, remoteAddress, remotePort,
694                            remotePathContext, secureConnection, remoteGroupId,
695                            remotePrivateLayout, startDate, endDate, groupName, cronText,
696                            schedulerStartDate, schedulerEndDate, description);
697            }
698    
699            /**
700            * Sets the layouts for the group, replacing and prioritizing all layouts of
701            * the parent layout.
702            *
703            * @param groupId the primary key of the group
704            * @param privateLayout whether the layout is private to the group
705            * @param parentLayoutId the primary key of the parent layout
706            * @param layoutIds the primary keys of the layouts
707            * @param serviceContext the service context to be applied
708            * @throws PortalException if a group or layout with the primary key could
709            not be found, if the group did not have permission to manage the
710            layouts, if no layouts were specified, if the first layout was
711            not page-able, if the first layout was hidden, or if some other
712            portal exception occurred
713            * @throws SystemException if a system exception occurred
714            */
715            public void setLayouts(long groupId, boolean privateLayout,
716                    long parentLayoutId, long[] layoutIds,
717                    com.liferay.portal.service.ServiceContext serviceContext)
718                    throws com.liferay.portal.kernel.exception.PortalException,
719                            com.liferay.portal.kernel.exception.SystemException {
720                    _layoutService.setLayouts(groupId, privateLayout, parentLayoutId,
721                            layoutIds, serviceContext);
722            }
723    
724            /**
725            * Deletes the job from the scheduler's queue.
726            *
727            * @param groupId the primary key of the group
728            * @param jobName the job name
729            * @param groupName the group name (optionally {@link
730            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
731            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
732            * @throws PortalException if the group did not permission to manage staging
733            and publish
734            * @throws SystemException if a system exception occurred
735            */
736            public void unschedulePublishToLive(long groupId, java.lang.String jobName,
737                    java.lang.String groupName)
738                    throws com.liferay.portal.kernel.exception.PortalException,
739                            com.liferay.portal.kernel.exception.SystemException {
740                    _layoutService.unschedulePublishToLive(groupId, jobName, groupName);
741            }
742    
743            /**
744            * Deletes the job from the scheduler's persistent queue.
745            *
746            * @param groupId the primary key of the group
747            * @param jobName the job name
748            * @param groupName the group name (optionally {@link
749            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
750            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
751            * @throws PortalException if a group with the primary key could not be
752            found or if the group did not have permission to publish
753            * @throws SystemException if a system exception occurred
754            */
755            public void unschedulePublishToRemote(long groupId,
756                    java.lang.String jobName, java.lang.String groupName)
757                    throws com.liferay.portal.kernel.exception.PortalException,
758                            com.liferay.portal.kernel.exception.SystemException {
759                    _layoutService.unschedulePublishToRemote(groupId, jobName, groupName);
760            }
761    
762            /**
763            * Updates the layout.
764            *
765            * @param groupId the primary key of the group
766            * @param privateLayout whether the layout is private to the group
767            * @param layoutId the primary key of the layout
768            * @param parentLayoutId the primary key of the layout's new parent layout
769            * @param localeNamesMap the layout's locales and localized names
770            * @param localeTitlesMap the layout's locales and localized titles
771            * @param descriptionMap the locales and localized descriptions to merge
772            (optionally <code>null</code>)
773            * @param keywordsMap the locales and localized keywords to merge
774            (optionally <code>null</code>)
775            * @param robotsMap the locales and localized robots to merge (optionally
776            <code>null</code>)
777            * @param type the layout's new type (optionally {@link
778            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET})
779            * @param hidden whether the layout is hidden
780            * @param friendlyURL the layout's new friendly URL (optionally {@link
781            com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}
782            or {@link
783            com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}).
784            The default values can be overridden in
785            <code>portal-ext.properties</code> by specifying new values for
786            the corresponding properties defined in {@link
787            com.liferay.portal.util.PropsValues}. To see how the URL is
788            normalized when accessed see {@link
789            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
790            String)}.
791            * @param iconImage whether the icon image will be updated
792            * @param iconBytes the byte array of the layout's new icon image
793            * @param serviceContext the service context to be applied. Can set the
794            modification date and expando bridge attributes for the layout.
795            * @return the updated layout
796            * @throws PortalException if a group or layout with the primary key could
797            not be found, if the user did not have permission to update the
798            layout, if a unique friendly URL could not be generated, if a
799            valid parent layout ID to use could not be found, or if the
800            layout parameters were invalid
801            * @throws SystemException if a system exception occurred
802            */
803            public com.liferay.portal.model.Layout updateLayout(long groupId,
804                    boolean privateLayout, long layoutId, long parentLayoutId,
805                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
806                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
807                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
808                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
809                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
810                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
811                    java.lang.Boolean iconImage, byte[] iconBytes,
812                    com.liferay.portal.service.ServiceContext serviceContext)
813                    throws com.liferay.portal.kernel.exception.PortalException,
814                            com.liferay.portal.kernel.exception.SystemException {
815                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
816                            parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap,
817                            keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage,
818                            iconBytes, serviceContext);
819            }
820    
821            /**
822            * Updates the layout replacing its type settings.
823            *
824            * @param groupId the primary key of the group
825            * @param privateLayout whether the layout is private to the group
826            * @param layoutId the primary key of the layout
827            * @param typeSettings the settings to load the unicode properties object.
828            See {@link com.liferay.portal.kernel.util.UnicodeProperties
829            #fastLoad(String)}.
830            * @return the updated layout
831            * @throws PortalException if a matching layout could not be found or if the
832            user did not have permission to update the layout
833            * @throws SystemException if a system exception occurred
834            */
835            public com.liferay.portal.model.Layout updateLayout(long groupId,
836                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
837                    throws com.liferay.portal.kernel.exception.PortalException,
838                            com.liferay.portal.kernel.exception.SystemException {
839                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
840                            typeSettings);
841            }
842    
843            /**
844            * Updates the look and feel of the layout.
845            *
846            * @param groupId the primary key of the group
847            * @param privateLayout whether the layout is private to the group
848            * @param layoutId the primary key of the layout
849            * @param themeId the primary key of the layout's new theme
850            * @param colorSchemeId the primary key of the layout's new color scheme
851            * @param css the layout's new CSS
852            * @param wapTheme whether the theme is for WAP browsers
853            * @return the updated layout
854            * @throws PortalException if a matching layout could not be found, or if
855            the user did not have permission to update the layout and
856            permission to apply the theme
857            * @throws SystemException if a system exception occurred
858            */
859            public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
860                    boolean privateLayout, long layoutId, java.lang.String themeId,
861                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
862                    throws com.liferay.portal.kernel.exception.PortalException,
863                            com.liferay.portal.kernel.exception.SystemException {
864                    return _layoutService.updateLookAndFeel(groupId, privateLayout,
865                            layoutId, themeId, colorSchemeId, css, wapTheme);
866            }
867    
868            /**
869            * Updates the name of the layout matching the group, layout ID, and
870            * privacy.
871            *
872            * @param groupId the primary key of the group
873            * @param privateLayout whether the layout is private to the group
874            * @param layoutId the primary key of the layout
875            * @param name the layout's new name
876            * @param languageId the primary key of the language. For more information
877            see {@link java.util.Locale}.
878            * @return the updated layout
879            * @throws PortalException if a matching layout could not be found, if the
880            user did not have permission to update the layout, or if the new
881            name was <code>null</code>
882            * @throws SystemException if a system exception occurred
883            */
884            public com.liferay.portal.model.Layout updateName(long groupId,
885                    boolean privateLayout, long layoutId, java.lang.String name,
886                    java.lang.String languageId)
887                    throws com.liferay.portal.kernel.exception.PortalException,
888                            com.liferay.portal.kernel.exception.SystemException {
889                    return _layoutService.updateName(groupId, privateLayout, layoutId,
890                            name, languageId);
891            }
892    
893            /**
894            * Updates the name of the layout matching the primary key.
895            *
896            * @param plid the primary key of the layout
897            * @param name the name to be assigned
898            * @param languageId the primary key of the language. For more information
899            see {@link java.util.Locale}.
900            * @return the updated layout
901            * @throws PortalException if a layout with the primary key could not be
902            found, or if the user did not have permission to update the
903            layout, or if the name was <code>null</code>
904            * @throws SystemException if a system exception occurred
905            */
906            public com.liferay.portal.model.Layout updateName(long plid,
907                    java.lang.String name, java.lang.String languageId)
908                    throws com.liferay.portal.kernel.exception.PortalException,
909                            com.liferay.portal.kernel.exception.SystemException {
910                    return _layoutService.updateName(plid, name, languageId);
911            }
912    
913            /**
914            * Updates the parent layout ID of the layout matching the group, layout ID,
915            * and privacy.
916            *
917            * @param groupId the primary key of the group
918            * @param privateLayout whether the layout is private to the group
919            * @param layoutId the primary key of the layout
920            * @param parentLayoutId the primary key to be assigned to the parent
921            layout
922            * @return the matching layout
923            * @throws PortalException if a valid parent layout ID to use could not be
924            found, if a matching layout could not be found, or if the user
925            did not have permission to update the layout
926            * @throws SystemException if a system exception occurred
927            */
928            public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
929                    boolean privateLayout, long layoutId, long parentLayoutId)
930                    throws com.liferay.portal.kernel.exception.PortalException,
931                            com.liferay.portal.kernel.exception.SystemException {
932                    return _layoutService.updateParentLayoutId(groupId, privateLayout,
933                            layoutId, parentLayoutId);
934            }
935    
936            /**
937            * Updates the parent layout ID of the layout matching the primary key. If a
938            * layout matching the parent primary key is found, the layout ID of that
939            * layout is assigned, otherwise {@link
940            * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is
941            * assigned.
942            *
943            * @param plid the primary key of the layout
944            * @param parentPlid the primary key of the parent layout
945            * @return the layout matching the primary key
946            * @throws PortalException if a layout with the primary key could not be
947            found, if the user did not have permission to update the layout,
948            or if a valid parent layout ID to use could not be found
949            * @throws SystemException if a system exception occurred
950            */
951            public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
952                    long parentPlid)
953                    throws com.liferay.portal.kernel.exception.PortalException,
954                            com.liferay.portal.kernel.exception.SystemException {
955                    return _layoutService.updateParentLayoutId(plid, parentPlid);
956            }
957    
958            /**
959            * Updates the priority of the layout matching the group, layout ID, and
960            * privacy.
961            *
962            * @param groupId the primary key of the group
963            * @param privateLayout whether the layout is private to the group
964            * @param layoutId the primary key of the layout
965            * @param priority the layout's new priority
966            * @return the updated layout
967            * @throws PortalException if a matching layout could not be found or if the
968            user did not have permission to update the layout
969            * @throws SystemException if a system exception occurred
970            */
971            public com.liferay.portal.model.Layout updatePriority(long groupId,
972                    boolean privateLayout, long layoutId, int priority)
973                    throws com.liferay.portal.kernel.exception.PortalException,
974                            com.liferay.portal.kernel.exception.SystemException {
975                    return _layoutService.updatePriority(groupId, privateLayout, layoutId,
976                            priority);
977            }
978    
979            /**
980            * Updates the priority of the layout matching the primary key.
981            *
982            * @param plid the primary key of the layout
983            * @param priority the layout's new priority
984            * @return the updated layout
985            * @throws PortalException if a layout with the primary key could not be
986            found
987            * @throws SystemException if a system exception occurred
988            */
989            public com.liferay.portal.model.Layout updatePriority(long plid,
990                    int priority)
991                    throws com.liferay.portal.kernel.exception.PortalException,
992                            com.liferay.portal.kernel.exception.SystemException {
993                    return _layoutService.updatePriority(plid, priority);
994            }
995    
996            /**
997             * @deprecated As of 6.1.0, replaced by {@link #getWrappedService}
998             */
999            public LayoutService getWrappedLayoutService() {
1000                    return _layoutService;
1001            }
1002    
1003            /**
1004             * @deprecated As of 6.1.0, replaced by {@link #setWrappedService}
1005             */
1006            public void setWrappedLayoutService(LayoutService layoutService) {
1007                    _layoutService = layoutService;
1008            }
1009    
1010            public LayoutService getWrappedService() {
1011                    return _layoutService;
1012            }
1013    
1014            public void setWrappedService(LayoutService layoutService) {
1015                    _layoutService = layoutService;
1016            }
1017    
1018            private LayoutService _layoutService;
1019    }