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