001    /**
002     * Copyright (c) 2000-2013 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    import aQute.bnd.annotation.ProviderType;
018    
019    /**
020     * Provides a wrapper for {@link LayoutService}.
021     *
022     * @author Brian Wing Shun Chan
023     * @see LayoutService
024     * @generated
025     */
026    @ProviderType
027    public class LayoutServiceWrapper implements LayoutService,
028            ServiceWrapper<LayoutService> {
029            public LayoutServiceWrapper(LayoutService layoutService) {
030                    _layoutService = layoutService;
031            }
032    
033            /**
034            * Returns the Spring bean ID for this bean.
035            *
036            * @return the Spring bean ID for this bean
037            */
038            @Override
039            public java.lang.String getBeanIdentifier() {
040                    return _layoutService.getBeanIdentifier();
041            }
042    
043            /**
044            * Sets the Spring bean ID for this bean.
045            *
046            * @param beanIdentifier the Spring bean ID for this bean
047            */
048            @Override
049            public void setBeanIdentifier(java.lang.String beanIdentifier) {
050                    _layoutService.setBeanIdentifier(beanIdentifier);
051            }
052    
053            /**
054            * Adds a layout with additional parameters.
055            *
056            * <p>
057            * This method handles the creation of the layout including its resources,
058            * metadata, and internal data structures. It is not necessary to make
059            * subsequent calls to any methods to setup default groups, resources, ...
060            * etc.
061            * </p>
062            *
063            * @param groupId the primary key of the group
064            * @param privateLayout whether the layout is private to the group
065            * @param parentLayoutId the primary key of the parent layout
066            (optionally {@link
067            com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
068            * @param localeNamesMap the layout's locales and localized names
069            * @param localeTitlesMap the layout's locales and localized titles
070            * @param descriptionMap the layout's locales and localized
071            descriptions
072            * @param keywordsMap the layout's locales and localized keywords
073            * @param robotsMap the layout's locales and localized robots
074            * @param type the layout's type (optionally {@link
075            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The
076            possible types can be found in {@link
077            com.liferay.portal.model.LayoutConstants}.
078            * @param hidden whether the layout is hidden
079            * @param friendlyURL the layout's locales and localized friendly URLs.
080            To see how the URL is normalized when accessed, see {@link
081            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
082            String)}.
083            * @param serviceContext the service context to be applied. Must set
084            the UUID for the layout. Can set the creation date,
085            modification date, and expando bridge attributes for the
086            layout. For layouts that belong to a layout set prototype, an
087            attribute named <code>layoutUpdateable</code> can be used to
088            specify whether site administrators can modify this page
089            within their site.
090            * @return the layout
091            * @throws PortalException if a group with the primary key could not be
092            found, if the group did not have permission to manage the
093            layouts involved, if layout values were invalid, or if a
094            portal exception occurred
095            * @throws SystemException if a system exception occurred
096            * @deprecated As of 6.2.0, replaced by {@link #addLayout(long, boolean,
097            long, Map, Map, Map, Map, Map, String, String, boolean, Map,
098            ServiceContext)}
099            */
100            @Override
101            public com.liferay.portal.model.Layout addLayout(long groupId,
102                    boolean privateLayout, long parentLayoutId,
103                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
104                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
105                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
106                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
107                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
108                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
109                    com.liferay.portal.service.ServiceContext serviceContext)
110                    throws com.liferay.portal.kernel.exception.PortalException,
111                            com.liferay.portal.kernel.exception.SystemException {
112                    return _layoutService.addLayout(groupId, privateLayout, parentLayoutId,
113                            localeNamesMap, localeTitlesMap, descriptionMap, keywordsMap,
114                            robotsMap, type, hidden, friendlyURL, serviceContext);
115            }
116    
117            /**
118            * Adds a layout with additional parameters.
119            *
120            * <p>
121            * This method handles the creation of the layout including its resources,
122            * metadata, and internal data structures. It is not necessary to make
123            * subsequent calls to any methods to setup default groups, resources, ...
124            * etc.
125            * </p>
126            *
127            * @param groupId the primary key of the group
128            * @param privateLayout whether the layout is private to the group
129            * @param parentLayoutId the primary key of the parent layout (optionally
130            {@link
131            com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
132            * @param localeNamesMap the layout's locales and localized names
133            * @param localeTitlesMap the layout's locales and localized titles
134            * @param descriptionMap the layout's locales and localized descriptions
135            * @param keywordsMap the layout's locales and localized keywords
136            * @param robotsMap the layout's locales and localized robots
137            * @param type the layout's type (optionally {@link
138            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The
139            possible types can be found in {@link
140            com.liferay.portal.model.LayoutConstants}.
141            * @param typeSettings the settings to load the unicode properties object.
142            See {@link com.liferay.portal.kernel.util.UnicodeProperties
143            #fastLoad(String)}.
144            * @param hidden whether the layout is hidden
145            * @param friendlyURLMap the layout's locales and localized friendly URLs.
146            To see how the URL is normalized when accessed, see {@link
147            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
148            String)}.
149            * @param serviceContext the service context to be applied. Must set the
150            UUID for the layout. Can set the creation date, modification
151            date, and expando bridge attributes for the layout. For layouts
152            that belong to a layout set prototype, an attribute named
153            <code>layoutUpdateable</code> can be used to specify whether site
154            administrators can modify this page within their site.
155            * @return the layout
156            * @throws PortalException if a group with the primary key could not be
157            found, if the group did not have permission to manage the layouts
158            involved, if layout values were invalid, or if a portal exception
159            occurred
160            * @throws SystemException if a system exception occurred
161            */
162            @Override
163            public com.liferay.portal.model.Layout addLayout(long groupId,
164                    boolean privateLayout, long parentLayoutId,
165                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
166                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
167                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
168                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
169                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
170                    java.lang.String type, java.lang.String typeSettings, boolean hidden,
171                    java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap,
172                    com.liferay.portal.service.ServiceContext serviceContext)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException {
175                    return _layoutService.addLayout(groupId, privateLayout, parentLayoutId,
176                            localeNamesMap, localeTitlesMap, descriptionMap, keywordsMap,
177                            robotsMap, type, typeSettings, hidden, friendlyURLMap,
178                            serviceContext);
179            }
180    
181            /**
182            * Adds a layout with single entry maps for name, title, and description to
183            * the default locale.
184            *
185            * <p>
186            * This method handles the creation of the layout including its resources,
187            * metadata, and internal data structures. It is not necessary to make
188            * subsequent calls to any methods to setup default groups, resources, ...
189            * etc.
190            * </p>
191            *
192            * @param groupId the primary key of the group
193            * @param privateLayout whether the layout is private to the group
194            * @param parentLayoutId the primary key of the parent layout (optionally
195            {@link
196            com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
197            * @param name Map the layout's locales and localized names
198            * @param title Map the layout's locales and localized titles
199            * @param description Map the layout's locales and localized descriptions
200            * @param type the layout's type (optionally {@link
201            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The
202            possible types can be found in {@link
203            com.liferay.portal.model.LayoutConstants}.
204            * @param hidden whether the layout is hidden
205            * @param friendlyURL the layout's locales and localized friendly URLs. To
206            see how the URL is normalized when accessed, see {@link
207            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
208            String)}.
209            * @param serviceContext the service context to be applied. Must set the
210            UUID for the layout. Can specify the creation date, modification
211            date, and expando bridge attributes for the layout. For layouts
212            that belong to a layout set prototype, an attribute named
213            <code>layoutUpdateable</code> can be used to specify whether site
214            administrators can modify this page within their site.
215            * @return the layout
216            * @throws PortalException if a group with the primary key could not be
217            found, if the group did not have permission to manage the layouts
218            involved, if layout values were invalid, or if a portal exception
219            occurred
220            * @throws SystemException if a system exception occurred
221            */
222            @Override
223            public com.liferay.portal.model.Layout addLayout(long groupId,
224                    boolean privateLayout, long parentLayoutId, java.lang.String name,
225                    java.lang.String title, java.lang.String description,
226                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
227                    com.liferay.portal.service.ServiceContext serviceContext)
228                    throws com.liferay.portal.kernel.exception.PortalException,
229                            com.liferay.portal.kernel.exception.SystemException {
230                    return _layoutService.addLayout(groupId, privateLayout, parentLayoutId,
231                            name, title, description, type, hidden, friendlyURL, serviceContext);
232            }
233    
234            @Override
235            public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry(
236                    long groupId, java.lang.String fileName,
237                    java.lang.String tempFolderName, java.io.InputStream inputStream,
238                    java.lang.String mimeType)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException {
241                    return _layoutService.addTempFileEntry(groupId, fileName,
242                            tempFolderName, inputStream, mimeType);
243            }
244    
245            /**
246            * Deletes the layout with the primary key, also deleting the layout's child
247            * layouts, and associated resources.
248            *
249            * @param groupId the primary key of the group
250            * @param privateLayout whether the layout is private to the group
251            * @param layoutId the primary key of the layout
252            * @param serviceContext the service context to be applied
253            * @throws PortalException if the user did not have permission to delete the
254            layout, if a matching layout could not be found , or if some
255            other portal exception occurred
256            * @throws SystemException if a system exception occurred
257            */
258            @Override
259            public void deleteLayout(long groupId, boolean privateLayout,
260                    long layoutId, com.liferay.portal.service.ServiceContext serviceContext)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    _layoutService.deleteLayout(groupId, privateLayout, layoutId,
264                            serviceContext);
265            }
266    
267            /**
268            * Deletes the layout with the plid, also deleting the layout's child
269            * layouts, and associated resources.
270            *
271            * @param plid the primary key of the layout
272            * @param serviceContext the service context to be applied
273            * @throws PortalException if the user did not have permission to delete the
274            layout, if a layout with the primary key could not be found , or
275            if some other portal exception occurred
276            * @throws SystemException if a system exception occurred
277            */
278            @Override
279            public void deleteLayout(long plid,
280                    com.liferay.portal.service.ServiceContext serviceContext)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    _layoutService.deleteLayout(plid, serviceContext);
284            }
285    
286            @Override
287            public void deleteTempFileEntry(long groupId, java.lang.String fileName,
288                    java.lang.String tempFolderName)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    _layoutService.deleteTempFileEntry(groupId, fileName, tempFolderName);
292            }
293    
294            /**
295            * Exports the layouts that match the primary keys and the criteria as a
296            * byte array.
297            *
298            * @param groupId the primary key of the group
299            * @param privateLayout whether the layout is private to the group
300            * @param layoutIds the primary keys of the layouts to be exported
301            * @param parameterMap the mapping of parameters indicating which
302            information to export. For information on the keys used in the
303            map see {@link
304            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
305            * @param startDate the export's start date
306            * @param endDate the export's end date
307            * @return the layouts as a byte array
308            * @throws PortalException if a group or any layout with the primary key
309            could not be found, if the group did not have permission to
310            manage the layouts, or if some other portal exception occurred
311            * @throws SystemException if a system exception occurred
312            */
313            @Override
314            public byte[] exportLayouts(long groupId, boolean privateLayout,
315                    long[] layoutIds,
316                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
317                    java.util.Date startDate, java.util.Date endDate)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    return _layoutService.exportLayouts(groupId, privateLayout, layoutIds,
321                            parameterMap, startDate, endDate);
322            }
323    
324            /**
325            * Exports all layouts that match the criteria as a byte array.
326            *
327            * @param groupId the primary key of the group
328            * @param privateLayout whether the layout is private to the group
329            * @param parameterMap the mapping of parameters indicating which
330            information to export. For information on the keys used in the
331            map see {@link
332            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
333            * @param startDate the export's start date
334            * @param endDate the export's end date
335            * @return the layout as a byte array
336            * @throws PortalException if a group with the primary key could not be
337            found, if the group did not have permission to manage the
338            layouts, or if some other portal exception occurred
339            * @throws SystemException if a system exception occurred
340            */
341            @Override
342            public byte[] exportLayouts(long groupId, boolean privateLayout,
343                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
344                    java.util.Date startDate, java.util.Date endDate)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return _layoutService.exportLayouts(groupId, privateLayout,
348                            parameterMap, startDate, endDate);
349            }
350    
351            /**
352            * Exports all layouts that match the primary keys and criteria as a file.
353            *
354            * @param groupId the primary key of the group
355            * @param privateLayout whether the layout is private to the group
356            * @param layoutIds the primary keys of the layouts to be exported
357            (optionally <code>null</code>)
358            * @param parameterMap the mapping of parameters indicating which
359            information to export. For information on the keys used in the
360            map see {@link
361            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
362            * @param startDate the export's start date
363            * @param endDate the export's end date
364            * @return the layouts as a File
365            * @throws PortalException if a group or any layout with the primary key
366            could not be found, it the group did not have permission to
367            manage the layouts, or if some other portal exception occurred
368            * @throws SystemException if a system exception occurred
369            */
370            @Override
371            public java.io.File exportLayoutsAsFile(long groupId,
372                    boolean privateLayout, long[] layoutIds,
373                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
374                    java.util.Date startDate, java.util.Date endDate)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException {
377                    return _layoutService.exportLayoutsAsFile(groupId, privateLayout,
378                            layoutIds, parameterMap, startDate, endDate);
379            }
380    
381            @Override
382            public long exportLayoutsAsFileInBackground(java.lang.String taskName,
383                    long groupId, boolean privateLayout, long[] layoutIds,
384                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
385                    java.util.Date startDate, java.util.Date endDate,
386                    java.lang.String fileName)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    return _layoutService.exportLayoutsAsFileInBackground(taskName,
390                            groupId, privateLayout, layoutIds, parameterMap, startDate,
391                            endDate, fileName);
392            }
393    
394            /**
395            * Exports the portlet information (categories, permissions, ... etc.) as a
396            * byte array.
397            *
398            * @param plid the primary key of the layout
399            * @param groupId the primary key of the group
400            * @param portletId the primary key of the portlet
401            * @param parameterMap the mapping of parameters indicating which
402            information to export. For information on the keys used in the
403            map see {@link
404            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
405            * @param startDate the export's start date
406            * @param endDate the export's end date
407            * @return the portlet information as a byte array
408            * @throws PortalException if a layout, group, or portlet with the primary
409            key could not be found, if the group did not have permission to
410            manage the layouts involved, or if some other portal exception
411            occurred
412            * @throws SystemException if a system exception occurred
413            */
414            @Override
415            public byte[] exportPortletInfo(long plid, long groupId,
416                    java.lang.String portletId,
417                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
418                    java.util.Date startDate, java.util.Date endDate)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    return _layoutService.exportPortletInfo(plid, groupId, portletId,
422                            parameterMap, startDate, endDate);
423            }
424    
425            @Override
426            public byte[] exportPortletInfo(long companyId, java.lang.String portletId,
427                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
428                    java.util.Date startDate, java.util.Date endDate)
429                    throws com.liferay.portal.kernel.exception.PortalException,
430                            com.liferay.portal.kernel.exception.SystemException {
431                    return _layoutService.exportPortletInfo(companyId, portletId,
432                            parameterMap, startDate, endDate);
433            }
434    
435            /**
436            * Exports the portlet information (categories, permissions, ... etc.) as a
437            * file.
438            *
439            * @param plid the primary key of the layout
440            * @param groupId the primary key of the group
441            * @param portletId the primary key of the portlet
442            * @param parameterMap the mapping of parameters indicating which
443            information to export. For information on the keys used in the
444            map see {@link
445            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
446            * @param startDate the export's start date
447            * @param endDate the export's end date
448            * @return the portlet information as a file
449            * @throws PortalException if a layout, group, or portlet with the primary
450            key could not be found, it the group did not have permission to
451            manage the layouts involved, or if some other portal exception
452            occurred
453            * @throws SystemException if a system exception occurred
454            */
455            @Override
456            public java.io.File exportPortletInfoAsFile(long plid, long groupId,
457                    java.lang.String portletId,
458                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
459                    java.util.Date startDate, java.util.Date endDate)
460                    throws com.liferay.portal.kernel.exception.PortalException,
461                            com.liferay.portal.kernel.exception.SystemException {
462                    return _layoutService.exportPortletInfoAsFile(plid, groupId, portletId,
463                            parameterMap, startDate, endDate);
464            }
465    
466            @Override
467            public java.io.File exportPortletInfoAsFile(java.lang.String portletId,
468                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
469                    java.util.Date startDate, java.util.Date endDate)
470                    throws com.liferay.portal.kernel.exception.PortalException,
471                            com.liferay.portal.kernel.exception.SystemException {
472                    return _layoutService.exportPortletInfoAsFile(portletId, parameterMap,
473                            startDate, endDate);
474            }
475    
476            @Override
477            public long exportPortletInfoAsFileInBackground(java.lang.String taskName,
478                    long plid, long groupId, java.lang.String portletId,
479                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
480                    java.util.Date startDate, java.util.Date endDate,
481                    java.lang.String fileName)
482                    throws com.liferay.portal.kernel.exception.PortalException,
483                            com.liferay.portal.kernel.exception.SystemException {
484                    return _layoutService.exportPortletInfoAsFileInBackground(taskName,
485                            plid, groupId, portletId, parameterMap, startDate, endDate, fileName);
486            }
487    
488            @Override
489            public long exportPortletInfoAsFileInBackground(java.lang.String taskName,
490                    java.lang.String portletId,
491                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
492                    java.util.Date startDate, java.util.Date endDate,
493                    java.lang.String fileName)
494                    throws com.liferay.portal.kernel.exception.PortalException,
495                            com.liferay.portal.kernel.exception.SystemException {
496                    return _layoutService.exportPortletInfoAsFileInBackground(taskName,
497                            portletId, parameterMap, startDate, endDate, fileName);
498            }
499    
500            /**
501            * Returns all the ancestor layouts of the layout.
502            *
503            * @param plid the primary key of the layout
504            * @return the ancestor layouts of the layout
505            * @throws PortalException if a matching layout could not be found or if a
506            portal exception occurred
507            * @throws SystemException if a system exception occurred
508            */
509            @Override
510            public java.util.List<com.liferay.portal.model.Layout> getAncestorLayouts(
511                    long plid)
512                    throws com.liferay.portal.kernel.exception.PortalException,
513                            com.liferay.portal.kernel.exception.SystemException {
514                    return _layoutService.getAncestorLayouts(plid);
515            }
516    
517            /**
518            * Returns the primary key of the default layout for the group.
519            *
520            * @param groupId the primary key of the group
521            * @param scopeGroupId the primary key of the scope group. See {@link
522            com.liferay.portal.service.ServiceContext#getScopeGroupId()}.
523            * @param privateLayout whether the layout is private to the group
524            * @param portletId the primary key of the portlet
525            * @return Returns the primary key of the default layout group; {@link
526            com.liferay.portal.model.LayoutConstants#DEFAULT_PLID} otherwise
527            * @throws PortalException if a group, layout, or portlet with the primary
528            key could not be found
529            * @throws SystemException if a system exception occurred
530            */
531            @Override
532            public long getDefaultPlid(long groupId, long scopeGroupId,
533                    boolean privateLayout, java.lang.String portletId)
534                    throws com.liferay.portal.kernel.exception.PortalException,
535                            com.liferay.portal.kernel.exception.SystemException {
536                    return _layoutService.getDefaultPlid(groupId, scopeGroupId,
537                            privateLayout, portletId);
538            }
539    
540            @Override
541            public long getDefaultPlid(long groupId, long scopeGroupId,
542                    java.lang.String portletId)
543                    throws com.liferay.portal.kernel.exception.PortalException,
544                            com.liferay.portal.kernel.exception.SystemException {
545                    return _layoutService.getDefaultPlid(groupId, scopeGroupId, portletId);
546            }
547    
548            /**
549            * Returns the layout matching the UUID, group, and privacy.
550            *
551            * @param uuid the layout's UUID
552            * @param groupId the primary key of the group
553            * @param privateLayout whether the layout is private to the group
554            * @return the matching layout
555            * @throws PortalException if a matching layout could not be found, if the
556            user did not have permission to view the layout, or if some other
557            portal exception occurred
558            * @throws SystemException if a system exception occurred
559            */
560            @Override
561            public com.liferay.portal.model.Layout getLayoutByUuidAndGroupId(
562                    java.lang.String uuid, long groupId, boolean privateLayout)
563                    throws com.liferay.portal.kernel.exception.PortalException,
564                            com.liferay.portal.kernel.exception.SystemException {
565                    return _layoutService.getLayoutByUuidAndGroupId(uuid, groupId,
566                            privateLayout);
567            }
568    
569            /**
570            * Returns the name of the layout.
571            *
572            * @param groupId the primary key of the group
573            * @param privateLayout whether the layout is private to the group
574            * @param layoutId the primary key of the layout
575            * @param languageId the primary key of the language. For more information
576            See {@link java.util.Locale}.
577            * @return the layout's name
578            * @throws PortalException if a matching layout could not be found
579            * @throws SystemException if a system exception occurred
580            */
581            @Override
582            public java.lang.String getLayoutName(long groupId, boolean privateLayout,
583                    long layoutId, java.lang.String languageId)
584                    throws com.liferay.portal.kernel.exception.PortalException,
585                            com.liferay.portal.kernel.exception.SystemException {
586                    return _layoutService.getLayoutName(groupId, privateLayout, layoutId,
587                            languageId);
588            }
589    
590            /**
591            * Returns the layout references for all the layouts that belong to the
592            * company and belong to the portlet that matches the preferences.
593            *
594            * @param companyId the primary key of the company
595            * @param portletId the primary key of the portlet
596            * @param preferencesKey the portlet's preference key
597            * @param preferencesValue the portlet's preference value
598            * @return the layout references of the matching layouts
599            * @throws SystemException if a system exception occurred
600            */
601            @Override
602            public com.liferay.portal.model.LayoutReference[] getLayoutReferences(
603                    long companyId, java.lang.String portletId,
604                    java.lang.String preferencesKey, java.lang.String preferencesValue)
605                    throws com.liferay.portal.kernel.exception.SystemException {
606                    return _layoutService.getLayoutReferences(companyId, portletId,
607                            preferencesKey, preferencesValue);
608            }
609    
610            @Override
611            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
612                    long groupId, boolean privateLayout)
613                    throws com.liferay.portal.kernel.exception.SystemException {
614                    return _layoutService.getLayouts(groupId, privateLayout);
615            }
616    
617            @Override
618            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
619                    long groupId, boolean privateLayout, long parentLayoutId)
620                    throws com.liferay.portal.kernel.exception.SystemException {
621                    return _layoutService.getLayouts(groupId, privateLayout, parentLayoutId);
622            }
623    
624            @Override
625            public java.util.List<com.liferay.portal.model.Layout> getLayouts(
626                    long groupId, boolean privateLayout, long parentLayoutId,
627                    boolean incomplete, int start, int end)
628                    throws com.liferay.portal.kernel.exception.PortalException,
629                            com.liferay.portal.kernel.exception.SystemException {
630                    return _layoutService.getLayouts(groupId, privateLayout,
631                            parentLayoutId, incomplete, start, end);
632            }
633    
634            @Override
635            public int getLayoutsCount(long groupId, boolean privateLayout,
636                    long parentLayoutId)
637                    throws com.liferay.portal.kernel.exception.SystemException {
638                    return _layoutService.getLayoutsCount(groupId, privateLayout,
639                            parentLayoutId);
640            }
641    
642            @Override
643            public int getLayoutsCount(long groupId, boolean privateLayout,
644                    long parentLayoutId, int priority)
645                    throws com.liferay.portal.kernel.exception.SystemException {
646                    return _layoutService.getLayoutsCount(groupId, privateLayout,
647                            parentLayoutId, priority);
648            }
649    
650            @Override
651            public java.lang.String[] getTempFileEntryNames(long groupId,
652                    java.lang.String tempFolderName)
653                    throws com.liferay.portal.kernel.exception.PortalException,
654                            com.liferay.portal.kernel.exception.SystemException {
655                    return _layoutService.getTempFileEntryNames(groupId, tempFolderName);
656            }
657    
658            /**
659            * Imports the layouts from the byte array.
660            *
661            * @param groupId the primary key of the group
662            * @param privateLayout whether the layout is private to the group
663            * @param parameterMap the mapping of parameters indicating which
664            information will be imported. For information on the keys used in
665            the map see {@link
666            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
667            * @param bytes the byte array with the data
668            * @throws PortalException if a group with the primary key could not be
669            found, if the group did not have permission to manage the
670            layouts, or if some other portal exception occurred
671            * @throws SystemException if a system exception occurred
672            * @see com.liferay.portal.lar.LayoutImporter
673            */
674            @Override
675            public void importLayouts(long groupId, boolean privateLayout,
676                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
677                    byte[] bytes)
678                    throws com.liferay.portal.kernel.exception.PortalException,
679                            com.liferay.portal.kernel.exception.SystemException {
680                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, bytes);
681            }
682    
683            /**
684            * Imports the layouts from the file.
685            *
686            * @param groupId the primary key of the group
687            * @param privateLayout whether the layout is private to the group
688            * @param parameterMap the mapping of parameters indicating which
689            information will be imported. For information on the keys used in
690            the map see {@link
691            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
692            * @param file the LAR file with the data
693            * @throws PortalException if a group with the primary key could not be
694            found, if the group did not have permission to manage the layouts
695            and publish, or if some other portal exception occurred
696            * @throws SystemException if a system exception occurred
697            * @see com.liferay.portal.lar.LayoutImporter
698            */
699            @Override
700            public void importLayouts(long groupId, boolean privateLayout,
701                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
702                    java.io.File file)
703                    throws com.liferay.portal.kernel.exception.PortalException,
704                            com.liferay.portal.kernel.exception.SystemException {
705                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, file);
706            }
707    
708            /**
709            * Imports the layouts from the input stream.
710            *
711            * @param groupId the primary key of the group
712            * @param privateLayout whether the layout is private to the group
713            * @param parameterMap the mapping of parameters indicating which
714            information will be imported. For information on the keys used in
715            the map see {@link
716            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
717            * @param is the input stream
718            * @throws PortalException if a group with the primary key could not be
719            found, if the group did not have permission to manage the
720            layouts, or if some other portal exception occurred
721            * @throws SystemException if a system exception occurred
722            * @see com.liferay.portal.lar.LayoutImporter
723            */
724            @Override
725            public void importLayouts(long groupId, boolean privateLayout,
726                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
727                    java.io.InputStream is)
728                    throws com.liferay.portal.kernel.exception.PortalException,
729                            com.liferay.portal.kernel.exception.SystemException {
730                    _layoutService.importLayouts(groupId, privateLayout, parameterMap, is);
731            }
732    
733            @Override
734            public long importLayoutsInBackground(java.lang.String taskName,
735                    long groupId, boolean privateLayout,
736                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
737                    java.io.File file)
738                    throws com.liferay.portal.kernel.exception.PortalException,
739                            com.liferay.portal.kernel.exception.SystemException {
740                    return _layoutService.importLayoutsInBackground(taskName, groupId,
741                            privateLayout, parameterMap, file);
742            }
743    
744            @Override
745            public long importLayoutsInBackground(java.lang.String taskName,
746                    long groupId, boolean privateLayout,
747                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
748                    java.io.InputStream inputStream)
749                    throws com.liferay.portal.kernel.exception.PortalException,
750                            com.liferay.portal.kernel.exception.SystemException {
751                    return _layoutService.importLayoutsInBackground(taskName, groupId,
752                            privateLayout, parameterMap, inputStream);
753            }
754    
755            /**
756            * Imports the portlet information (categories, permissions, ... etc.) from
757            * the file.
758            *
759            * @param plid the primary key of the layout
760            * @param groupId the primary key of the group
761            * @param portletId the primary key of the portlet
762            * @param parameterMap the mapping of parameters indicating which
763            information will be imported. For information on the keys used in
764            the map see {@link
765            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
766            * @param file the LAR file with the data
767            * @throws PortalException if a group, layout, or portlet with the primary
768            key could not be found, or if the group did not have permission
769            to manage the layouts
770            * @throws SystemException if a system exception occurred
771            */
772            @Override
773            public void importPortletInfo(long plid, long groupId,
774                    java.lang.String portletId,
775                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
776                    java.io.File file)
777                    throws com.liferay.portal.kernel.exception.PortalException,
778                            com.liferay.portal.kernel.exception.SystemException {
779                    _layoutService.importPortletInfo(plid, groupId, portletId,
780                            parameterMap, file);
781            }
782    
783            /**
784            * Imports the portlet information (categories, permissions, ... etc.) from
785            * the input stream.
786            *
787            * @param plid the primary key of the layout
788            * @param groupId the primary key of the group
789            * @param portletId the primary key of the portlet
790            * @param parameterMap the mapping of parameters indicating which
791            information will be imported. For information on the keys used in
792            the map see {@link
793            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}.
794            * @param is the input stream
795            * @throws PortalException if a group, portlet, or layout with the primary
796            key could not be found or if the group did not have permission to
797            manage the layouts
798            * @throws SystemException if a system exception occurred
799            */
800            @Override
801            public void importPortletInfo(long plid, long groupId,
802                    java.lang.String portletId,
803                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
804                    java.io.InputStream is)
805                    throws com.liferay.portal.kernel.exception.PortalException,
806                            com.liferay.portal.kernel.exception.SystemException {
807                    _layoutService.importPortletInfo(plid, groupId, portletId,
808                            parameterMap, is);
809            }
810    
811            @Override
812            public void importPortletInfo(java.lang.String portletId,
813                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
814                    java.io.File file)
815                    throws com.liferay.portal.kernel.exception.PortalException,
816                            com.liferay.portal.kernel.exception.SystemException {
817                    _layoutService.importPortletInfo(portletId, parameterMap, file);
818            }
819    
820            @Override
821            public void importPortletInfo(java.lang.String portletId,
822                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
823                    java.io.InputStream is)
824                    throws com.liferay.portal.kernel.exception.PortalException,
825                            com.liferay.portal.kernel.exception.SystemException {
826                    _layoutService.importPortletInfo(portletId, parameterMap, is);
827            }
828    
829            @Override
830            public long importPortletInfoInBackground(java.lang.String taskName,
831                    long plid, long groupId, java.lang.String portletId,
832                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
833                    java.io.File file)
834                    throws com.liferay.portal.kernel.exception.PortalException,
835                            com.liferay.portal.kernel.exception.SystemException {
836                    return _layoutService.importPortletInfoInBackground(taskName, plid,
837                            groupId, portletId, parameterMap, file);
838            }
839    
840            @Override
841            public long importPortletInfoInBackground(java.lang.String taskName,
842                    long plid, long groupId, java.lang.String portletId,
843                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
844                    java.io.InputStream is)
845                    throws com.liferay.portal.kernel.exception.PortalException,
846                            com.liferay.portal.kernel.exception.SystemException {
847                    return _layoutService.importPortletInfoInBackground(taskName, plid,
848                            groupId, portletId, parameterMap, is);
849            }
850    
851            @Override
852            public void importPortletInfoInBackground(java.lang.String taskName,
853                    java.lang.String portletId,
854                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
855                    java.io.File file)
856                    throws com.liferay.portal.kernel.exception.PortalException,
857                            com.liferay.portal.kernel.exception.SystemException {
858                    _layoutService.importPortletInfoInBackground(taskName, portletId,
859                            parameterMap, file);
860            }
861    
862            @Override
863            public void importPortletInfoInBackground(java.lang.String taskName,
864                    java.lang.String portletId,
865                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
866                    java.io.InputStream is)
867                    throws com.liferay.portal.kernel.exception.PortalException,
868                            com.liferay.portal.kernel.exception.SystemException {
869                    _layoutService.importPortletInfoInBackground(taskName, portletId,
870                            parameterMap, is);
871            }
872    
873            /**
874            * Schedules a range of layouts to be published.
875            *
876            * @param sourceGroupId the primary key of the source group
877            * @param targetGroupId the primary key of the target group
878            * @param privateLayout whether the layout is private to the group
879            * @param layoutIdMap the layouts considered for publishing, specified by
880            the layout IDs and booleans indicating whether they have children
881            * @param parameterMap the mapping of parameters indicating which
882            information will be used. See {@link
883            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}
884            * @param scope the scope of the pages. It can be <code>all-pages</code> or
885            <code>selected-pages</code>.
886            * @param startDate the start date
887            * @param endDate the end date
888            * @param groupName the group name (optionally {@link
889            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
890            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
891            * @param cronText the cron text. See {@link
892            com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText}
893            * @param schedulerStartDate the scheduler start date
894            * @param schedulerEndDate the scheduler end date
895            * @param description the scheduler description
896            * @throws PortalException if the group did not have permission to manage
897            and publish
898            * @throws SystemException if a system exception occurred
899            */
900            @Override
901            public void schedulePublishToLive(long sourceGroupId, long targetGroupId,
902                    boolean privateLayout,
903                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
904                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
905                    java.lang.String scope, java.util.Date startDate,
906                    java.util.Date endDate, java.lang.String groupName,
907                    java.lang.String cronText, java.util.Date schedulerStartDate,
908                    java.util.Date schedulerEndDate, java.lang.String description)
909                    throws com.liferay.portal.kernel.exception.PortalException,
910                            com.liferay.portal.kernel.exception.SystemException {
911                    _layoutService.schedulePublishToLive(sourceGroupId, targetGroupId,
912                            privateLayout, layoutIdMap, parameterMap, scope, startDate,
913                            endDate, groupName, cronText, schedulerStartDate, schedulerEndDate,
914                            description);
915            }
916    
917            /**
918            * Schedules a range of layouts to be stored.
919            *
920            * @param sourceGroupId the primary key of the source group
921            * @param privateLayout whether the layout is private to the group
922            * @param layoutIdMap the layouts considered for publishing, specified by
923            the layout IDs and booleans indicating whether they have children
924            * @param parameterMap the mapping of parameters indicating which
925            information will be used. See {@link
926            com.liferay.portal.kernel.lar.PortletDataHandlerKeys}
927            * @param remoteAddress the remote address
928            * @param remotePort the remote port
929            * @param remotePathContext the remote path context
930            * @param secureConnection whether the connection is secure
931            * @param remoteGroupId the primary key of the remote group
932            * @param remotePrivateLayout whether remote group's layout is private
933            * @param startDate the start date
934            * @param endDate the end date
935            * @param groupName the group name. Optionally {@link
936            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
937            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
938            * @param cronText the cron text. See {@link
939            com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText}
940            * @param schedulerStartDate the scheduler start date
941            * @param schedulerEndDate the scheduler end date
942            * @param description the scheduler description
943            * @throws PortalException if a group with the source group primary key was
944            not found or if the group did not have permission to publish
945            * @throws SystemException if a system exception occurred
946            */
947            @Override
948            public void schedulePublishToRemote(long sourceGroupId,
949                    boolean privateLayout,
950                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
951                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
952                    java.lang.String remoteAddress, int remotePort,
953                    java.lang.String remotePathContext, boolean secureConnection,
954                    long remoteGroupId, boolean remotePrivateLayout,
955                    java.util.Date startDate, java.util.Date endDate,
956                    java.lang.String groupName, java.lang.String cronText,
957                    java.util.Date schedulerStartDate, java.util.Date schedulerEndDate,
958                    java.lang.String description)
959                    throws com.liferay.portal.kernel.exception.PortalException,
960                            com.liferay.portal.kernel.exception.SystemException {
961                    _layoutService.schedulePublishToRemote(sourceGroupId, privateLayout,
962                            layoutIdMap, parameterMap, remoteAddress, remotePort,
963                            remotePathContext, secureConnection, remoteGroupId,
964                            remotePrivateLayout, startDate, endDate, groupName, cronText,
965                            schedulerStartDate, schedulerEndDate, description);
966            }
967    
968            /**
969            * Sets the layouts for the group, replacing and prioritizing all layouts of
970            * the parent layout.
971            *
972            * @param groupId the primary key of the group
973            * @param privateLayout whether the layout is private to the group
974            * @param parentLayoutId the primary key of the parent layout
975            * @param layoutIds the primary keys of the layouts
976            * @param serviceContext the service context to be applied
977            * @throws PortalException if a group or layout with the primary key could
978            not be found, if the group did not have permission to manage the
979            layouts, if no layouts were specified, if the first layout was
980            not page-able, if the first layout was hidden, or if some other
981            portal exception occurred
982            * @throws SystemException if a system exception occurred
983            */
984            @Override
985            public void setLayouts(long groupId, boolean privateLayout,
986                    long parentLayoutId, long[] layoutIds,
987                    com.liferay.portal.service.ServiceContext serviceContext)
988                    throws com.liferay.portal.kernel.exception.PortalException,
989                            com.liferay.portal.kernel.exception.SystemException {
990                    _layoutService.setLayouts(groupId, privateLayout, parentLayoutId,
991                            layoutIds, serviceContext);
992            }
993    
994            /**
995            * Deletes the job from the scheduler's queue.
996            *
997            * @param groupId the primary key of the group
998            * @param jobName the job name
999            * @param groupName the group name (optionally {@link
1000            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
1001            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
1002            * @throws PortalException if the group did not permission to manage staging
1003            and publish
1004            * @throws SystemException if a system exception occurred
1005            */
1006            @Override
1007            public void unschedulePublishToLive(long groupId, java.lang.String jobName,
1008                    java.lang.String groupName)
1009                    throws com.liferay.portal.kernel.exception.PortalException,
1010                            com.liferay.portal.kernel.exception.SystemException {
1011                    _layoutService.unschedulePublishToLive(groupId, jobName, groupName);
1012            }
1013    
1014            /**
1015            * Deletes the job from the scheduler's persistent queue.
1016            *
1017            * @param groupId the primary key of the group
1018            * @param jobName the job name
1019            * @param groupName the group name (optionally {@link
1020            com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}).
1021            See {@link com.liferay.portal.kernel.messaging.DestinationNames}.
1022            * @throws PortalException if a group with the primary key could not be
1023            found or if the group did not have permission to publish
1024            * @throws SystemException if a system exception occurred
1025            */
1026            @Override
1027            public void unschedulePublishToRemote(long groupId,
1028                    java.lang.String jobName, java.lang.String groupName)
1029                    throws com.liferay.portal.kernel.exception.PortalException,
1030                            com.liferay.portal.kernel.exception.SystemException {
1031                    _layoutService.unschedulePublishToRemote(groupId, jobName, groupName);
1032            }
1033    
1034            /**
1035            * Updates the layout with additional parameters.
1036            *
1037            * @param groupId the primary key of the group
1038            * @param privateLayout whether the layout is private to the group
1039            * @param layoutId the primary key of the layout
1040            * @param parentLayoutId the primary key of the layout's new parent layout
1041            * @param localeNamesMap the layout's locales and localized names
1042            * @param localeTitlesMap the layout's locales and localized titles
1043            * @param descriptionMap the locales and localized descriptions to merge
1044            (optionally <code>null</code>)
1045            * @param keywordsMap the locales and localized keywords to merge
1046            (optionally <code>null</code>)
1047            * @param robotsMap the locales and localized robots to merge (optionally
1048            <code>null</code>)
1049            * @param type the layout's new type (optionally {@link
1050            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET})
1051            * @param hidden whether the layout is hidden
1052            * @param friendlyURLMap the layout's locales and localized friendly URLs.
1053            To see how the URL is normalized when accessed see {@link
1054            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
1055            String)}.
1056            * @param iconImage whether the icon image will be updated
1057            * @param iconBytes the byte array of the layout's new icon image
1058            * @param serviceContext the service context to be applied. Can set the
1059            modification date and expando bridge attributes for the layout.
1060            * @return the updated layout
1061            * @throws PortalException if a group or layout with the primary key could
1062            not be found, if the user did not have permission to update the
1063            layout, if a unique friendly URL could not be generated, if a
1064            valid parent layout ID to use could not be found, or if the
1065            layout parameters were invalid
1066            * @throws SystemException if a system exception occurred
1067            */
1068            @Override
1069            public com.liferay.portal.model.Layout updateLayout(long groupId,
1070                    boolean privateLayout, long layoutId, long parentLayoutId,
1071                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
1072                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
1073                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
1074                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
1075                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
1076                    java.lang.String type, boolean hidden,
1077                    java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap,
1078                    java.lang.Boolean iconImage, byte[] iconBytes,
1079                    com.liferay.portal.service.ServiceContext serviceContext)
1080                    throws com.liferay.portal.kernel.exception.PortalException,
1081                            com.liferay.portal.kernel.exception.SystemException {
1082                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
1083                            parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap,
1084                            keywordsMap, robotsMap, type, hidden, friendlyURLMap, iconImage,
1085                            iconBytes, serviceContext);
1086            }
1087    
1088            /**
1089            * Updates the layout with additional parameters.
1090            *
1091            * @param groupId the primary key of the group
1092            * @param privateLayout whether the layout is private to the group
1093            * @param layoutId the primary key of the layout
1094            * @param parentLayoutId the primary key of the layout's new parent
1095            layout
1096            * @param localeNamesMap the layout's locales and localized names
1097            * @param localeTitlesMap the layout's locales and localized titles
1098            * @param descriptionMap the locales and localized descriptions to
1099            merge (optionally <code>null</code>)
1100            * @param keywordsMap the locales and localized keywords to merge
1101            (optionally <code>null</code>)
1102            * @param robotsMap the locales and localized robots to merge
1103            (optionally <code>null</code>)
1104            * @param type the layout's new type (optionally {@link
1105            com.liferay.portal.model.LayoutConstants#TYPE_PORTLET})
1106            * @param hidden whether the layout is hidden
1107            * @param friendlyURL the layout's locales and new friendly URLs. To
1108            see how the URL is normalized when accessed, see {@link
1109            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
1110            String)}.
1111            * @param iconImage whether the icon image will be updated
1112            * @param iconBytes the byte array of the layout's new icon image
1113            * @param serviceContext the service context to be applied. Can set the
1114            modification date and expando bridge attributes for the
1115            layout.
1116            * @return the updated layout
1117            * @throws PortalException if a group or layout with the primary key
1118            could not be found, if the user did not have permission to
1119            update the layout, if a unique friendly URL could not be
1120            generated, if a valid parent layout ID to use could not be
1121            found, or if the layout parameters were invalid
1122            * @throws SystemException if a system exception occurred
1123            * @deprecated As of 6.2.0, replaced by {@link #updateLayout(long, boolean,
1124            long, long, Map, Map, Map, Map, Map, String, boolean, Map,
1125            Boolean, byte[], ServiceContext)}
1126            */
1127            @Override
1128            public com.liferay.portal.model.Layout updateLayout(long groupId,
1129                    boolean privateLayout, long layoutId, long parentLayoutId,
1130                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
1131                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
1132                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
1133                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
1134                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
1135                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
1136                    java.lang.Boolean iconImage, byte[] iconBytes,
1137                    com.liferay.portal.service.ServiceContext serviceContext)
1138                    throws com.liferay.portal.kernel.exception.PortalException,
1139                            com.liferay.portal.kernel.exception.SystemException {
1140                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
1141                            parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap,
1142                            keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage,
1143                            iconBytes, serviceContext);
1144            }
1145    
1146            /**
1147            * Updates the layout replacing its type settings.
1148            *
1149            * @param groupId the primary key of the group
1150            * @param privateLayout whether the layout is private to the group
1151            * @param layoutId the primary key of the layout
1152            * @param typeSettings the settings to load the unicode properties object.
1153            See {@link com.liferay.portal.kernel.util.UnicodeProperties
1154            #fastLoad(String)}.
1155            * @return the updated layout
1156            * @throws PortalException if a matching layout could not be found or if the
1157            user did not have permission to update the layout
1158            * @throws SystemException if a system exception occurred
1159            */
1160            @Override
1161            public com.liferay.portal.model.Layout updateLayout(long groupId,
1162                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
1163                    throws com.liferay.portal.kernel.exception.PortalException,
1164                            com.liferay.portal.kernel.exception.SystemException {
1165                    return _layoutService.updateLayout(groupId, privateLayout, layoutId,
1166                            typeSettings);
1167            }
1168    
1169            /**
1170            * Updates the look and feel of the layout.
1171            *
1172            * @param groupId the primary key of the group
1173            * @param privateLayout whether the layout is private to the group
1174            * @param layoutId the primary key of the layout
1175            * @param themeId the primary key of the layout's new theme
1176            * @param colorSchemeId the primary key of the layout's new color scheme
1177            * @param css the layout's new CSS
1178            * @param wapTheme whether the theme is for WAP browsers
1179            * @return the updated layout
1180            * @throws PortalException if a matching layout could not be found, or if
1181            the user did not have permission to update the layout and
1182            permission to apply the theme
1183            * @throws SystemException if a system exception occurred
1184            */
1185            @Override
1186            public com.liferay.portal.model.Layout updateLookAndFeel(long groupId,
1187                    boolean privateLayout, long layoutId, java.lang.String themeId,
1188                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
1189                    throws com.liferay.portal.kernel.exception.PortalException,
1190                            com.liferay.portal.kernel.exception.SystemException {
1191                    return _layoutService.updateLookAndFeel(groupId, privateLayout,
1192                            layoutId, themeId, colorSchemeId, css, wapTheme);
1193            }
1194    
1195            /**
1196            * Updates the name of the layout matching the group, layout ID, and
1197            * privacy.
1198            *
1199            * @param groupId the primary key of the group
1200            * @param privateLayout whether the layout is private to the group
1201            * @param layoutId the primary key of the layout
1202            * @param name the layout's new name
1203            * @param languageId the primary key of the language. For more information
1204            see {@link java.util.Locale}.
1205            * @return the updated layout
1206            * @throws PortalException if a matching layout could not be found, if the
1207            user did not have permission to update the layout, or if the new
1208            name was <code>null</code>
1209            * @throws SystemException if a system exception occurred
1210            */
1211            @Override
1212            public com.liferay.portal.model.Layout updateName(long groupId,
1213                    boolean privateLayout, long layoutId, java.lang.String name,
1214                    java.lang.String languageId)
1215                    throws com.liferay.portal.kernel.exception.PortalException,
1216                            com.liferay.portal.kernel.exception.SystemException {
1217                    return _layoutService.updateName(groupId, privateLayout, layoutId,
1218                            name, languageId);
1219            }
1220    
1221            /**
1222            * Updates the name of the layout matching the primary key.
1223            *
1224            * @param plid the primary key of the layout
1225            * @param name the name to be assigned
1226            * @param languageId the primary key of the language. For more information
1227            see {@link java.util.Locale}.
1228            * @return the updated layout
1229            * @throws PortalException if a layout with the primary key could not be
1230            found, or if the user did not have permission to update the
1231            layout, or if the name was <code>null</code>
1232            * @throws SystemException if a system exception occurred
1233            */
1234            @Override
1235            public com.liferay.portal.model.Layout updateName(long plid,
1236                    java.lang.String name, java.lang.String languageId)
1237                    throws com.liferay.portal.kernel.exception.PortalException,
1238                            com.liferay.portal.kernel.exception.SystemException {
1239                    return _layoutService.updateName(plid, name, languageId);
1240            }
1241    
1242            /**
1243            * Updates the parent layout ID of the layout matching the group, layout ID,
1244            * and privacy.
1245            *
1246            * @param groupId the primary key of the group
1247            * @param privateLayout whether the layout is private to the group
1248            * @param layoutId the primary key of the layout
1249            * @param parentLayoutId the primary key to be assigned to the parent
1250            layout
1251            * @return the matching layout
1252            * @throws PortalException if a valid parent layout ID to use could not be
1253            found, if a matching layout could not be found, or if the user
1254            did not have permission to update the layout
1255            * @throws SystemException if a system exception occurred
1256            */
1257            @Override
1258            public com.liferay.portal.model.Layout updateParentLayoutId(long groupId,
1259                    boolean privateLayout, long layoutId, long parentLayoutId)
1260                    throws com.liferay.portal.kernel.exception.PortalException,
1261                            com.liferay.portal.kernel.exception.SystemException {
1262                    return _layoutService.updateParentLayoutId(groupId, privateLayout,
1263                            layoutId, parentLayoutId);
1264            }
1265    
1266            /**
1267            * Updates the parent layout ID of the layout matching the primary key. If a
1268            * layout matching the parent primary key is found, the layout ID of that
1269            * layout is assigned, otherwise {@link
1270            * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is
1271            * assigned.
1272            *
1273            * @param plid the primary key of the layout
1274            * @param parentPlid the primary key of the parent layout
1275            * @return the layout matching the primary key
1276            * @throws PortalException if a layout with the primary key could not be
1277            found, if the user did not have permission to update the layout,
1278            or if a valid parent layout ID to use could not be found
1279            * @throws SystemException if a system exception occurred
1280            */
1281            @Override
1282            public com.liferay.portal.model.Layout updateParentLayoutId(long plid,
1283                    long parentPlid)
1284                    throws com.liferay.portal.kernel.exception.PortalException,
1285                            com.liferay.portal.kernel.exception.SystemException {
1286                    return _layoutService.updateParentLayoutId(plid, parentPlid);
1287            }
1288    
1289            @Override
1290            public com.liferay.portal.model.Layout updateParentLayoutIdAndPriority(
1291                    long plid, long parentPlid, int priority)
1292                    throws com.liferay.portal.kernel.exception.PortalException,
1293                            com.liferay.portal.kernel.exception.SystemException {
1294                    return _layoutService.updateParentLayoutIdAndPriority(plid, parentPlid,
1295                            priority);
1296            }
1297    
1298            /**
1299            * Updates the priority of the layout matching the group, layout ID, and
1300            * privacy.
1301            *
1302            * @param groupId the primary key of the group
1303            * @param privateLayout whether the layout is private to the group
1304            * @param layoutId the primary key of the layout
1305            * @param priority the layout's new priority
1306            * @return the updated layout
1307            * @throws PortalException if a matching layout could not be found or if the
1308            user did not have permission to update the layout
1309            * @throws SystemException if a system exception occurred
1310            */
1311            @Override
1312            public com.liferay.portal.model.Layout updatePriority(long groupId,
1313                    boolean privateLayout, long layoutId, int priority)
1314                    throws com.liferay.portal.kernel.exception.PortalException,
1315                            com.liferay.portal.kernel.exception.SystemException {
1316                    return _layoutService.updatePriority(groupId, privateLayout, layoutId,
1317                            priority);
1318            }
1319    
1320            /**
1321            * Updates the priority of the layout matching the group, layout ID, and
1322            * privacy, setting the layout's priority based on the priorities of the
1323            * next and previous layouts.
1324            *
1325            * @param groupId the primary key of the group
1326            * @param privateLayout whether the layout is private to the group
1327            * @param layoutId the primary key of the layout
1328            * @param nextLayoutId the primary key of the next layout
1329            * @param previousLayoutId the primary key of the previous layout
1330            * @return the updated layout
1331            * @throws PortalException if a matching layout could not be found or if the
1332            user did not have permission to update the layout
1333            * @throws SystemException if a system exception occurred
1334            */
1335            @Override
1336            public com.liferay.portal.model.Layout updatePriority(long groupId,
1337                    boolean privateLayout, long layoutId, long nextLayoutId,
1338                    long previousLayoutId)
1339                    throws com.liferay.portal.kernel.exception.PortalException,
1340                            com.liferay.portal.kernel.exception.SystemException {
1341                    return _layoutService.updatePriority(groupId, privateLayout, layoutId,
1342                            nextLayoutId, previousLayoutId);
1343            }
1344    
1345            /**
1346            * Updates the priority of the layout matching the primary key.
1347            *
1348            * @param plid the primary key of the layout
1349            * @param priority the layout's new priority
1350            * @return the updated layout
1351            * @throws PortalException if a layout with the primary key could not be
1352            found
1353            * @throws SystemException if a system exception occurred
1354            */
1355            @Override
1356            public com.liferay.portal.model.Layout updatePriority(long plid,
1357                    int priority)
1358                    throws com.liferay.portal.kernel.exception.PortalException,
1359                            com.liferay.portal.kernel.exception.SystemException {
1360                    return _layoutService.updatePriority(plid, priority);
1361            }
1362    
1363            @Override
1364            public com.liferay.portal.kernel.lar.MissingReferences validateImportLayoutsFile(
1365                    long groupId, boolean privateLayout,
1366                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1367                    java.io.File file)
1368                    throws com.liferay.portal.kernel.exception.PortalException,
1369                            com.liferay.portal.kernel.exception.SystemException {
1370                    return _layoutService.validateImportLayoutsFile(groupId, privateLayout,
1371                            parameterMap, file);
1372            }
1373    
1374            @Override
1375            public com.liferay.portal.kernel.lar.MissingReferences validateImportLayoutsFile(
1376                    long groupId, boolean privateLayout,
1377                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1378                    java.io.InputStream inputStream)
1379                    throws com.liferay.portal.kernel.exception.PortalException,
1380                            com.liferay.portal.kernel.exception.SystemException {
1381                    return _layoutService.validateImportLayoutsFile(groupId, privateLayout,
1382                            parameterMap, inputStream);
1383            }
1384    
1385            @Override
1386            public com.liferay.portal.kernel.lar.MissingReferences validateImportPortletInfo(
1387                    long plid, long groupId, java.lang.String portletId,
1388                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1389                    java.io.File file)
1390                    throws com.liferay.portal.kernel.exception.PortalException,
1391                            com.liferay.portal.kernel.exception.SystemException {
1392                    return _layoutService.validateImportPortletInfo(plid, groupId,
1393                            portletId, parameterMap, file);
1394            }
1395    
1396            @Override
1397            public com.liferay.portal.kernel.lar.MissingReferences validateImportPortletInfo(
1398                    long plid, long groupId, java.lang.String portletId,
1399                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1400                    java.io.InputStream inputStream)
1401                    throws com.liferay.portal.kernel.exception.PortalException,
1402                            com.liferay.portal.kernel.exception.SystemException {
1403                    return _layoutService.validateImportPortletInfo(plid, groupId,
1404                            portletId, parameterMap, inputStream);
1405            }
1406    
1407            /**
1408             * @deprecated As of 6.1.0, replaced by {@link #getWrappedService}
1409             */
1410            public LayoutService getWrappedLayoutService() {
1411                    return _layoutService;
1412            }
1413    
1414            /**
1415             * @deprecated As of 6.1.0, replaced by {@link #setWrappedService}
1416             */
1417            public void setWrappedLayoutService(LayoutService layoutService) {
1418                    _layoutService = layoutService;
1419            }
1420    
1421            @Override
1422            public LayoutService getWrappedService() {
1423                    return _layoutService;
1424            }
1425    
1426            @Override
1427            public void setWrappedService(LayoutService layoutService) {
1428                    _layoutService = layoutService;
1429            }
1430    
1431            private LayoutService _layoutService;
1432    }