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