001    /**
002     * Copyright (c) 2000-2012 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. Must set the UUID for the
087            layout. Can set the creation date, modification date and the
088            expando bridge attributes for the layout. For layouts that belong
089            to a layout set prototype, an attribute named 'layoutUpdateable'
090            can be used to specify whether site administrators can modify
091            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. Must set the UUID for the
150            layout. Can specify the creation date, modification date and the
151            expando bridge attributes for the layout. For layouts that belong
152            to a layout set prototype, an attribute named 'layoutUpdateable'
153            can be used to specify whether site administrators can modify
154            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
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
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            /**
394            * @param uuid the layout's UUID
395            * @param groupId the primary key of the group
396            * @param privateLayout whether the layout is private to the group
397            * @return the matching layout
398            * @throws PortalException if a matching layout could not be found, if the
399            user did not have permission to view the layout, or if some other
400            portal exception occurred
401            * @throws SystemException if a system exception occurred
402            */
403            public com.liferay.portal.model.Layout getLayoutByUuidAndGroupId(
404                    java.lang.String uuid, long groupId, boolean privateLayout)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException {
407                    return _layoutService.getLayoutByUuidAndGroupId(uuid, groupId,
408                            privateLayout);
409            }
410    
411            /**
412            * Returns the name of the layout.
413            *
414            * @param groupId the primary key of the group
415            * @param privateLayout whether the layout is private to the group
416            * @param layoutId the primary key of the layout
417            * @param languageId the primary key of the language. For more information
418            See {@link java.util.Locale}.
419            * @return the layout's name
420            * @throws PortalException if a matching layout could not be found
421            * @throws SystemException if a system exception occurred
422            */
423            public java.lang.String getLayoutName(long groupId, boolean privateLayout,
424                    long layoutId, java.lang.String languageId)
425                    throws com.liferay.portal.kernel.exception.PortalException,
426                            com.liferay.portal.kernel.exception.SystemException {
427                    return _layoutService.getLayoutName(groupId, privateLayout, layoutId,
428                            languageId);
429            }
430    
431            /**
432            * Returns the layout references for all the layouts that belong to the
433            * company and belong to the portlet that matches the preferences.
434            *
435            * @param companyId the primary key of the company
436            * @param portletId the primary key of the portlet
437            * @param preferencesKey the portlet's preference key
438            * @param preferencesValue the portlet's preference value
439            * @return the layout references of the matching layouts
440            * @throws SystemException if a system exception occurred
441            */
442            public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
443                    long companyId, java.lang.String portletId,
444                    java.lang.String preferencesKey, java.lang.String preferencesValue)
445                    throws com.liferay.portal.kernel.exception.SystemException {
446                    return _layoutService.getLayoutReferences(companyId, portletId,
447                            preferencesKey, preferencesValue);
448            }
449    
450            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
451                    long groupId, boolean privateLayout)
452                    throws com.liferay.portal.kernel.exception.SystemException {
453                    return _layoutService.getLayouts(groupId, privateLayout);
454            }
455    
456            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
457                    long groupId, boolean privateLayout, long parentLayoutId)
458                    throws com.liferay.portal.kernel.exception.SystemException {
459                    return _layoutService.getLayouts(groupId, privateLayout, parentLayoutId);
460            }
461    
462            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
463                    long groupId, boolean privateLayout, long parentLayoutId,
464                    boolean incomplete, int start, int end)
465                    throws com.liferay.portal.kernel.exception.PortalException,
466                            com.liferay.portal.kernel.exception.SystemException {
467                    return _layoutService.getLayouts(groupId, privateLayout,
468                            parentLayoutId, incomplete, start, end);
469            }
470    
471            /**
472            * Imports the layouts from the byte array.
473            *
474            * @param groupId the primary key of the group
475            * @param privateLayout whether the layout is private to the group
476            * @param parameterMap the mapping of parameters indicating which
477            information will be imported. For information on the keys used in
478            the map see {@link
479            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
480            * @param bytes the byte array with the data
481            * @throws PortalException if a group with the primary key could not be
482            found, if the group did not have permission to manage the
483            layouts, or if some other portal exception occurred
484            * @throws SystemException if a system exception occurred
485            * @see com.liferay.portal.lar.LayoutImporter
486            */
487            public void importLayouts(long groupId, boolean privateLayout,
488                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
489                    byte[] bytes)
490                    throws com.liferay.portal.kernel.exception.PortalException,
491                            com.liferay.portal.kernel.exception.SystemException {
492                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, bytes);
493            }
494    
495            /**
496            * Imports the layouts from the file.
497            *
498            * @param groupId the primary key of the group
499            * @param privateLayout whether the layout is private to the group
500            * @param parameterMap the mapping of parameters indicating which
501            information will be imported. For information on the keys used in
502            the map see {@link
503            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
504            * @param file the LAR file with the data
505            * @throws PortalException if a group with the primary key could not be
506            found, if the group did not have permission to manage the layouts
507            and publish, or if some other portal exception occurred
508            * @throws SystemException if a system exception occurred
509            * @see com.liferay.portal.lar.LayoutImporter
510            */
511            public void importLayouts(long groupId, boolean privateLayout,
512                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
513                    java.io.File file)
514                    throws com.liferay.portal.kernel.exception.PortalException,
515                            com.liferay.portal.kernel.exception.SystemException {
516                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, file);
517            }
518    
519            /**
520            * Imports the layouts from the input stream.
521            *
522            * @param groupId the primary key of the group
523            * @param privateLayout whether the layout is private to the group
524            * @param parameterMap the mapping of parameters indicating which
525            information will be imported. For information on the keys used in
526            the map see {@link
527            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
528            * @param is the input stream
529            * @throws PortalException if a group with the primary key could not be
530            found, if the group did not have permission to manage the
531            layouts, or if some other portal exception occurred
532            * @throws SystemException if a system exception occurred
533            * @see com.liferay.portal.lar.LayoutImporter
534            */
535            public void importLayouts(long groupId, boolean privateLayout,
536                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
537                    java.io.InputStream is)
538                    throws com.liferay.portal.kernel.exception.PortalException,
539                            com.liferay.portal.kernel.exception.SystemException {
540                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, is);
541            }
542    
543            /**
544            * Imports the portlet information (categories, permissions, ... etc.) from
545            * the file.
546            *
547            * @param plid the primary key of the layout
548            * @param groupId the primary key of the group
549            * @param portletId the primary key of the portlet
550            * @param parameterMap the mapping of parameters indicating which
551            information will be imported. For information on the keys used in
552            the map see {@link
553            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
554            * @param file the LAR file with the data
555            * @throws PortalException if a group, layout, or portlet with the primary
556            key could not be found, or if the group did not have permission
557            to manage the layouts
558            * @throws SystemException if a system exception occurred
559            */
560            public void importPortletInfo(long plid, long groupId,
561                    java.lang.String portletId,
562                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
563                    java.io.File file)
564                    throws com.liferay.portal.kernel.exception.PortalException,
565                            com.liferay.portal.kernel.exception.SystemException {
566                    _layoutService.importPortletInfo(plid, groupId, portletId,
567                            parameterMap, file);
568            }
569    
570            /**
571            * Imports the portlet information (categories, permissions, ... etc.) from
572            * the input stream.
573            *
574            * @param plid the primary key of the layout
575            * @param groupId the primary key of the group
576            * @param portletId the primary key of the portlet
577            * @param parameterMap the mapping of parameters indicating which
578            information will be imported. For information on the keys used in
579            the map see {@link
580            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
581            * @param is the input stream
582            * @throws PortalException if a group, portlet, or layout with the primary
583            key could not be found or if the group did not have permission to
584            manage the layouts
585            * @throws SystemException if a system exception occurred
586            */
587            public void importPortletInfo(long plid, long groupId,
588                    java.lang.String portletId,
589                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
590                    java.io.InputStream is)
591                    throws com.liferay.portal.kernel.exception.PortalException,
592                            com.liferay.portal.kernel.exception.SystemException {
593                    _layoutService.importPortletInfo(plid, groupId, portletId,
594                            parameterMap, is);
595            }
596    
597            /**
598            * Schedules a range of layouts to be published.
599            *
600            * @param sourceGroupId the primary key of the source group
601            * @param targetGroupId the primary key of the target group
602            * @param privateLayout whether the layout is private to the group
603            * @param layoutIdMap the layouts considered for publishing, specified by
604            the layout IDs and booleans indicating whether they have children
605            * @param parameterMap the mapping of parameters indicating which
606            information will be used. See {@link
607            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}
608            * @param scope the scope of the pages. It can be <code>all-pages</code> or
609            <code>selected-pages</code>.
610            * @param startDate the start date
611            * @param endDate the end date
612            * @param groupName the group name (optionally {@link
613            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
614            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
615            * @param cronText the cron text. See {@link
616            com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText}
617            * @param schedulerStartDate the scheduler start date
618            * @param schedulerEndDate the scheduler end date
619            * @param description the scheduler description
620            * @throws PortalException if the group did not have permission to manage
621            and publish
622            * @throws SystemException if a system exception occurred
623            */
624            public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
625                    boolean privateLayout,
626                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
627                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
628                    java.lang.String scope, java.util.Date startDate,
629                    java.util.Date endDate, java.lang.String groupName,
630                    java.lang.String cronText, java.util.Date schedulerStartDate,
631                    java.util.Date schedulerEndDate, java.lang.String description)
632                    throws com.liferay.portal.kernel.exception.PortalException,
633                            com.liferay.portal.kernel.exception.SystemException {
634                    _layoutService.schedulePublishToLive(sourceGroupId, targetGroupId,
635                            privateLayout, layoutIdMap, parameterMap, scope, startDate,
636                            endDate, groupName, cronText, schedulerStartDate, schedulerEndDate,
637                            description);
638            }
639    
640            /**
641            * Schedules a range of layouts to be stored.
642            *
643            * @param sourceGroupId the primary key of the source group
644            * @param privateLayout whether the layout is private to the group
645            * @param layoutIdMap the layouts considered for publishing, specified by
646            the layout IDs and booleans indicating whether they have children
647            * @param parameterMap the mapping of parameters indicating which
648            information will be used. See {@link
649            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}
650            * @param remoteAddress the remote address
651            * @param remotePort the remote port
652            * @param remotePathContext the remote path context
653            * @param secureConnection whether the connection is secure
654            * @param remoteGroupId the primary key of the remote group
655            * @param remotePrivateLayout whether remote group's layout is private
656            * @param startDate the start date
657            * @param endDate the end date
658            * @param groupName the group name. Optionally {@link
659            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
660            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
661            * @param cronText the cron text. See {@link
662            com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText}
663            * @param schedulerStartDate the scheduler start date
664            * @param schedulerEndDate the scheduler end date
665            * @param description the scheduler description
666            * @throws PortalException if a group with the source group primary key was
667            not found or if the group did not have permission to publish
668            * @throws SystemException if a system exception occurred
669            */
670            public void schedulePublishToRemote(long sourceGroupId,
671                    boolean privateLayout,
672                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
673                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
674                    java.lang.String remoteAddress, int remotePort,
675                    java.lang.String remotePathContext, boolean secureConnection,
676                    long remoteGroupId, boolean remotePrivateLayout,
677                    java.util.Date startDate, java.util.Date endDate,
678                    java.lang.String groupName, java.lang.String cronText,
679                    java.util.Date schedulerStartDate, java.util.Date schedulerEndDate,
680                    java.lang.String description)
681                    throws com.liferay.portal.kernel.exception.PortalException,
682                            com.liferay.portal.kernel.exception.SystemException {
683                    _layoutService.schedulePublishToRemote(sourceGroupId, privateLayout,
684                            layoutIdMap, parameterMap, remoteAddress, remotePort,
685                            remotePathContext, secureConnection, remoteGroupId,
686                            remotePrivateLayout, startDate, endDate, groupName, cronText,
687                            schedulerStartDate, schedulerEndDate, description);
688            }
689    
690            /**
691            * Sets the layouts for the group, replacing and prioritizing all layouts of
692            * the parent layout.
693            *
694            * @param groupId the primary key of the group
695            * @param privateLayout whether the layout is private to the group
696            * @param parentLayoutId the primary key of the parent layout
697            * @param layoutIds the primary keys of the layouts
698            * @param serviceContext the service context
699            * @throws PortalException if a group or layout with the primary key could
700            not be found, if the group did not have permission to manage the
701            layouts, if no layouts were specified, if the first layout was
702            not page-able, if the first layout was hidden, or if some other
703            portal exception occurred
704            * @throws SystemException if a system exception occurred
705            */
706            public void setLayouts(long groupId, boolean privateLayout,
707                    long parentLayoutId, long[] layoutIds,
708                    com.liferay.portal.service.ServiceContext serviceContext)
709                    throws com.liferay.portal.kernel.exception.PortalException,
710                            com.liferay.portal.kernel.exception.SystemException {
711                    _layoutService.setLayouts(groupId, privateLayout, parentLayoutId,
712                            layoutIds, serviceContext);
713            }
714    
715            /**
716            * Deletes the job from the scheduler's queue.
717            *
718            * @param groupId the primary key of the group
719            * @param jobName the job name
720            * @param groupName the group name (optionally {@link
721            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
722            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
723            * @throws PortalException if the group did not permission to manage staging
724            and publish
725            * @throws SystemException if a system exception occurred
726            */
727            public void unschedulePublishToLive(long groupId, java.lang.String jobName,
728                    java.lang.String groupName)
729                    throws com.liferay.portal.kernel.exception.PortalException,
730                            com.liferay.portal.kernel.exception.SystemException {
731                    _layoutService.unschedulePublishToLive(groupId, jobName, groupName);
732            }
733    
734            /**
735            * Deletes the job from the scheduler's persistent queue.
736            *
737            * @param groupId the primary key of the group
738            * @param jobName the job name
739            * @param groupName the group name (optionally {@link
740            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
741            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
742            * @throws PortalException if a group with the primary key could not be
743            found or if the group did not have permission to publish
744            * @throws SystemException if a system exception occurred
745            */
746            public void unschedulePublishToRemote(long groupId,
747                    java.lang.String jobName, java.lang.String groupName)
748                    throws com.liferay.portal.kernel.exception.PortalException,
749                            com.liferay.portal.kernel.exception.SystemException {
750                    _layoutService.unschedulePublishToRemote(groupId, jobName, groupName);
751            }
752    
753            /**
754            * Updates the layout.
755            *
756            * @param groupId the primary key of the group
757            * @param privateLayout whether the layout is private to the group
758            * @param layoutId the primary key of the layout
759            * @param parentLayoutId the primary key of the layout's new parent layout
760            * @param localeNamesMap the layout's locales and localized names
761            * @param localeTitlesMap the layout's locales and localized titles
762            * @param descriptionMap the locales and localized descriptions to merge
763            (optionally <code>null</code>)
764            * @param keywordsMap the locales and localized keywords to merge
765            (optionally <code>null</code>)
766            * @param robotsMap the locales and localized robots to merge (optionally
767            <code>null</code>)
768            * @param type the layout's new type (optionally {@link
769            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET})
770            * @param hidden whether the layout is hidden
771            * @param friendlyURL the layout's new friendly URL (optionally {@link
772            com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}
773            or {@link
774            com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}).
775            The default values can be overridden in
776            <code>portal-ext.properties</code> by specifying new values for
777            the corresponding properties defined in {@link
778            com.liferay.portal.util.PropsValues}. To see how the URL is
779            normalized when accessed see {@link
780            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
781            String)}.
782            * @param iconImage whether the icon image will be updated
783            * @param iconBytes the byte array of the layout's new icon image
784            * @param serviceContext the service context. Can set the modification date
785            and expando bridge attributes for the layout.
786            * @return the updated layout
787            * @throws PortalException if a group or layout with the primary key could
788            not be found, if the user did not have permission to update the
789            layout, if a unique friendly URL could not be generated, if a
790            valid parent layout ID to use could not be found, or if the
791            layout parameters were invalid
792            * @throws SystemException if a system exception occurred
793            */
794            public com.liferay.portal.model.Layout updateLayout(long groupId,
795                    boolean privateLayout, long layoutId, long parentLayoutId,
796                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
797                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
798                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
799                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
800                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
801                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
802                    java.lang.Boolean iconImage, byte[] iconBytes,
803                    com.liferay.portal.service.ServiceContext serviceContext)
804                    throws com.liferay.portal.kernel.exception.PortalException,
805                            com.liferay.portal.kernel.exception.SystemException {
806                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
807                            parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap,
808                            keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage,
809                            iconBytes, serviceContext);
810            }
811    
812            /**
813            * Updates the layout replacing its type settings.
814            *
815            * @param groupId the primary key of the group
816            * @param privateLayout whether the layout is private to the group
817            * @param layoutId the primary key of the layout
818            * @param typeSettings the settings to load the unicode properties object.
819            See {@link com.liferay.portal.kernel.util.UnicodeProperties
820            #fastLoad(String)}.
821            * @return the updated layout
822            * @throws PortalException if a matching layout could not be found or if the
823            user did not have permission to update the layout
824            * @throws SystemException if a system exception occurred
825            */
826            public com.liferay.portal.model.Layout updateLayout(long groupId,
827                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
828                    throws com.liferay.portal.kernel.exception.PortalException,
829                            com.liferay.portal.kernel.exception.SystemException {
830                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
831                            typeSettings);
832            }
833    
834            /**
835            * Updates the look and feel of the layout.
836            *
837            * @param groupId the primary key of the group
838            * @param privateLayout whether the layout is private to the group
839            * @param layoutId the primary key of the layout
840            * @param themeId the primary key of the layout's new theme
841            * @param colorSchemeId the primary key of the layout's new color scheme
842            * @param css the layout's new CSS
843            * @param wapTheme whether the theme is for WAP browsers
844            * @return the updated layout
845            * @throws PortalException if a matching layout could not be found, or if
846            the user did not have permission to update the layout and
847            permission to apply the theme
848            * @throws SystemException if a system exception occurred
849            */
850            public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
851                    boolean privateLayout, long layoutId, java.lang.String themeId,
852                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
853                    throws com.liferay.portal.kernel.exception.PortalException,
854                            com.liferay.portal.kernel.exception.SystemException {
855                    return _layoutService.updateLookAndFeel(groupId, privateLayout,
856                            layoutId, themeId, colorSchemeId, css, wapTheme);
857            }
858    
859            /**
860            * Updates the name of the layout matching the group, layout ID, and
861            * privacy.
862            *
863            * @param groupId the primary key of the group
864            * @param privateLayout whether the layout is private to the group
865            * @param layoutId the primary key of the layout
866            * @param name the layout's new name
867            * @param languageId the primary key of the language. For more information
868            see {@link java.util.Locale}.
869            * @return the updated layout
870            * @throws PortalException if a matching layout could not be found, if the
871            user did not have permission to update the layout, or if the new
872            name was <code>null</code>
873            * @throws SystemException if a system exception occurred
874            */
875            public com.liferay.portal.model.Layout updateName(long groupId,
876                    boolean privateLayout, long layoutId, java.lang.String name,
877                    java.lang.String languageId)
878                    throws com.liferay.portal.kernel.exception.PortalException,
879                            com.liferay.portal.kernel.exception.SystemException {
880                    return _layoutService.updateName(groupId, privateLayout, layoutId,
881                            name, languageId);
882            }
883    
884            /**
885            * Updates the name of the layout matching the primary key.
886            *
887            * @param plid the primary key of the layout
888            * @param name the name to be assigned
889            * @param languageId the primary key of the language. For more information
890            see {@link java.util.Locale}.
891            * @return the updated layout
892            * @throws PortalException if a layout with the primary key could not be
893            found, or if the user did not have permission to update the
894            layout, or if the name was <code>null</code>
895            * @throws SystemException if a system exception occurred
896            */
897            public com.liferay.portal.model.Layout updateName(long plid,
898                    java.lang.String name, java.lang.String languageId)
899                    throws com.liferay.portal.kernel.exception.PortalException,
900                            com.liferay.portal.kernel.exception.SystemException {
901                    return _layoutService.updateName(plid, name, languageId);
902            }
903    
904            /**
905            * Updates the parent layout ID of the layout matching the group, layout ID,
906            * and privacy.
907            *
908            * @param groupId the primary key of the group
909            * @param privateLayout whether the layout is private to the group
910            * @param layoutId the primary key of the layout
911            * @param parentLayoutId the primary key to be assigned to the parent
912            layout
913            * @return the matching layout
914            * @throws PortalException if a valid parent layout ID to use could not be
915            found, if a matching layout could not be found, or if the user
916            did not have permission to update the layout
917            * @throws SystemException if a system exception occurred
918            */
919            public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
920                    boolean privateLayout, long layoutId, long parentLayoutId)
921                    throws com.liferay.portal.kernel.exception.PortalException,
922                            com.liferay.portal.kernel.exception.SystemException {
923                    return _layoutService.updateParentLayoutId(groupId, privateLayout,
924                            layoutId, parentLayoutId);
925            }
926    
927            /**
928            * Updates the parent layout ID of the layout matching the primary key. If a
929            * layout matching the parent primary key is found, the layout ID of that
930            * layout is assigned, otherwise {@link
931            * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is
932            * assigned.
933            *
934            * @param plid the primary key of the layout
935            * @param parentPlid the primary key of the parent layout
936            * @return the layout matching the primary key
937            * @throws PortalException if a layout with the primary key could not be
938            found, if the user did not have permission to update the layout,
939            or if a valid parent layout ID to use could not be found
940            * @throws SystemException if a system exception occurred
941            */
942            public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
943                    long parentPlid)
944                    throws com.liferay.portal.kernel.exception.PortalException,
945                            com.liferay.portal.kernel.exception.SystemException {
946                    return _layoutService.updateParentLayoutId(plid, parentPlid);
947            }
948    
949            /**
950            * Updates the priority of the layout matching the group, layout ID, and
951            * privacy.
952            *
953            * @param groupId the primary key of the group
954            * @param privateLayout whether the layout is private to the group
955            * @param layoutId the primary key of the layout
956            * @param priority the layout's new priority
957            * @return the updated layout
958            * @throws PortalException if a matching layout could not be found or if the
959            user did not have permission to update the layout
960            * @throws SystemException if a system exception occurred
961            */
962            public com.liferay.portal.model.Layout updatePriority(long groupId,
963                    boolean privateLayout, long layoutId, int priority)
964                    throws com.liferay.portal.kernel.exception.PortalException,
965                            com.liferay.portal.kernel.exception.SystemException {
966                    return _layoutService.updatePriority(groupId, privateLayout, layoutId,
967                            priority);
968            }
969    
970            /**
971            * Updates the priority of the layout matching the primary key.
972            *
973            * @param plid the primary key of the layout
974            * @param priority the layout's new priority
975            * @return the updated layout
976            * @throws PortalException if a layout with the primary key could not be
977            found
978            * @throws SystemException if a system exception occurred
979            */
980            public com.liferay.portal.model.Layout updatePriority(long plid,
981                    int priority)
982                    throws com.liferay.portal.kernel.exception.PortalException,
983                            com.liferay.portal.kernel.exception.SystemException {
984                    return _layoutService.updatePriority(plid, priority);
985            }
986    
987            /**
988             * @deprecated Renamed to {@link #getWrappedService}
989             */
990            public LayoutService getWrappedLayoutService() {
991                    return _layoutService;
992            }
993    
994            /**
995             * @deprecated Renamed to {@link #setWrappedService}
996             */
997            public void setWrappedLayoutService(LayoutService layoutService) {
998                    _layoutService = layoutService;
999            }
1000    
1001            public LayoutService getWrappedService() {
1002                    return _layoutService;
1003            }
1004    
1005            public void setWrappedService(LayoutService layoutService) {
1006                    _layoutService = layoutService;
1007            }
1008    
1009            private LayoutService _layoutService;
1010    }