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 local service utility for Layout. This utility wraps
024     * {@link com.liferay.portal.service.impl.LayoutLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see LayoutLocalService
032     * @see com.liferay.portal.service.base.LayoutLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LayoutLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class LayoutLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the layout to the database. Also notifies the appropriate model listeners.
046            *
047            * @param layout the layout
048            * @return the layout that was added
049            */
050            public static com.liferay.portal.model.Layout addLayout(
051                    com.liferay.portal.model.Layout layout) {
052                    return getService().addLayout(layout);
053            }
054    
055            /**
056            * Adds a layout with single entry maps for name, title, and description to
057            * the default locale.
058            *
059            * <p>
060            * This method handles the creation of the layout including its resources,
061            * metadata, and internal data structures. It is not necessary to make
062            * subsequent calls to any methods to setup default groups, resources, ...
063            * etc.
064            * </p>
065            *
066            * @param userId the primary key of the user
067            * @param groupId the primary key of the group
068            * @param privateLayout whether the layout is private to the group
069            * @param parentLayoutId the primary key of the parent layout (optionally
070            {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}). The possible
071            values can be found in {@link LayoutConstants}.
072            * @param name the layout's name (optionally {@link
073            PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_NAME} or {@link
074            PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_NAME}). The default values
075            can be overridden in <code>portal-ext.properties</code> by
076            specifying new values for the corresponding properties defined in
077            {@link PropsValues}
078            * @param title the layout's title
079            * @param description the layout's description
080            * @param type the layout's type (optionally {@link
081            LayoutConstants#TYPE_PORTLET}). The possible types can be found
082            in {@link LayoutConstants}.
083            * @param hidden whether the layout is hidden
084            * @param friendlyURL the friendly URL of the layout (optionally {@link
085            PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} or {@link
086            PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). The
087            default values can be overridden in
088            <code>portal-ext.properties</code> by specifying new values for
089            the corresponding properties defined in {@link PropsValues}. To
090            see how the URL is normalized when accessed, see {@link
091            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
092            String)}.
093            * @param serviceContext the service context to be applied. Must set the
094            UUID for the layout. Can set the creation date and modification
095            date for the layout. For layouts that belong to a layout set
096            prototype, an attribute named <code>layoutUpdateable</code> can
097            be set to specify whether site administrators can modify this
098            page within their site.
099            * @return the layout
100            */
101            public static com.liferay.portal.model.Layout addLayout(long userId,
102                    long groupId, boolean privateLayout, long parentLayoutId,
103                    java.lang.String name, java.lang.String title,
104                    java.lang.String description, java.lang.String type, boolean hidden,
105                    java.lang.String friendlyURL,
106                    com.liferay.portal.service.ServiceContext serviceContext)
107                    throws com.liferay.portal.kernel.exception.PortalException {
108                    return getService()
109                                       .addLayout(userId, groupId, privateLayout, parentLayoutId,
110                            name, title, description, type, hidden, friendlyURL, serviceContext);
111            }
112    
113            /**
114            * Adds a layout.
115            *
116            * <p>
117            * This method handles the creation of the layout including its resources,
118            * metadata, and internal data structures. It is not necessary to make
119            * subsequent calls to any methods to setup default groups, resources, ...
120            * etc.
121            * </p>
122            *
123            * @param userId the primary key of the user
124            * @param groupId the primary key of the group
125            * @param privateLayout whether the layout is private to the group
126            * @param parentLayoutId the primary key of the parent layout
127            (optionally {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
128            * @param nameMap the layout's locales and localized names
129            * @param titleMap the layout's locales and localized titles
130            * @param descriptionMap the layout's locales and localized
131            descriptions
132            * @param keywordsMap the layout's locales and localized keywords
133            * @param robotsMap the layout's locales and localized robots
134            * @param type the layout's type (optionally {@link
135            LayoutConstants#TYPE_PORTLET}). The possible types can be
136            found in {@link LayoutConstants}.
137            * @param hidden whether the layout is hidden
138            * @param friendlyURL the layout's friendly URL (optionally {@link
139            PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} or
140            {@link PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}).
141            The default values can be overridden in
142            <code>portal-ext.properties</code> by specifying new values
143            for the corresponding properties defined in {@link
144            PropsValues}. To see how the URL is normalized when accessed,
145            see {@link
146            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
147            String)}.
148            * @param serviceContext the service context to be applied. Must set
149            the UUID for the layout. Can set the creation date,
150            modification date and the expando bridge attributes for the
151            layout. For layouts that belong to a layout set prototype, an
152            attribute named <code>layoutUpdateable</code> can be set to
153            specify whether site administrators can modify this page
154            within their site. For layouts that are created from a layout
155            prototype, attributes named <code>layoutPrototypeUuid</code>
156            and <code>layoutPrototypeLinkedEnabled</code> can be
157            specified to provide the unique identifier of the source
158            prototype and a boolean to determine whether a link to it
159            should be enabled to activate propagation of changes made to
160            the linked page in the prototype.
161            * @return the layout
162            * @deprecated As of 6.2.0, replaced by {@link #addLayout(long, long,
163            boolean, long, Map, Map, Map, Map, Map, String, String,
164            boolean, Map, ServiceContext)}
165            */
166            @Deprecated
167            public static com.liferay.portal.model.Layout addLayout(long userId,
168                    long groupId, boolean privateLayout, long parentLayoutId,
169                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
170                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
171                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
172                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
173                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
174                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
175                    com.liferay.portal.service.ServiceContext serviceContext)
176                    throws com.liferay.portal.kernel.exception.PortalException {
177                    return getService()
178                                       .addLayout(userId, groupId, privateLayout, parentLayoutId,
179                            nameMap, titleMap, descriptionMap, keywordsMap, robotsMap, type,
180                            hidden, friendlyURL, serviceContext);
181            }
182    
183            /**
184            * Adds a layout with additional parameters.
185            *
186            * <p>
187            * This method handles the creation of the layout including its resources,
188            * metadata, and internal data structures. It is not necessary to make
189            * subsequent calls to any methods to setup default groups, resources, ...
190            * etc.
191            * </p>
192            *
193            * @param userId the primary key of the user
194            * @param groupId the primary key of the group
195            * @param privateLayout whether the layout is private to the group
196            * @param parentLayoutId the primary key of the parent layout (optionally
197            {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID})
198            * @param nameMap the layout's locales and localized names
199            * @param titleMap the layout's locales and localized titles
200            * @param descriptionMap the layout's locales and localized descriptions
201            * @param keywordsMap the layout's locales and localized keywords
202            * @param robotsMap the layout's locales and localized robots
203            * @param type the layout's type (optionally {@link
204            LayoutConstants#TYPE_PORTLET}). The possible types can be found
205            in {@link LayoutConstants}.
206            * @param typeSettings the settings to load the unicode properties object.
207            See {@link UnicodeProperties #fastLoad(String)}.
208            * @param hidden whether the layout is hidden
209            * @param friendlyURLMap the layout's locales and localized friendly URLs.
210            To see how the URL is normalized when accessed, see {@link
211            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
212            String)}.
213            * @param serviceContext the service context to be applied. Must set the
214            UUID for the layout. Can set the creation date, modification
215            date, and expando bridge attributes for the layout. For layouts
216            that belong to a layout set prototype, an attribute named
217            <code>layoutUpdateable</code> can be set to specify whether site
218            administrators can modify this page within their site. For
219            layouts that are created from a layout prototype, attributes
220            named <code>layoutPrototypeUuid</code> and
221            <code>layoutPrototypeLinkedEnabled</code> can be specified to
222            provide the unique identifier of the source prototype and a
223            boolean to determine whether a link to it should be enabled to
224            activate propagation of changes made to the linked page in the
225            prototype.
226            * @return the layout
227            */
228            public static com.liferay.portal.model.Layout addLayout(long userId,
229                    long groupId, boolean privateLayout, long parentLayoutId,
230                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
231                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
232                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
233                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
234                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
235                    java.lang.String type, java.lang.String typeSettings, boolean hidden,
236                    java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap,
237                    com.liferay.portal.service.ServiceContext serviceContext)
238                    throws com.liferay.portal.kernel.exception.PortalException {
239                    return getService()
240                                       .addLayout(userId, groupId, privateLayout, parentLayoutId,
241                            nameMap, titleMap, descriptionMap, keywordsMap, robotsMap, type,
242                            typeSettings, hidden, friendlyURLMap, serviceContext);
243            }
244    
245            /**
246            * Creates a new layout with the primary key. Does not add the layout to the database.
247            *
248            * @param plid the primary key for the new layout
249            * @return the new layout
250            */
251            public static com.liferay.portal.model.Layout createLayout(long plid) {
252                    return getService().createLayout(plid);
253            }
254    
255            /**
256            * Deletes the layout with the primary key, also deleting the layout's child
257            * layouts, and associated resources.
258            *
259            * @param groupId the primary key of the group
260            * @param privateLayout whether the layout is private to the group
261            * @param layoutId the primary key of the layout
262            * @param serviceContext the service context to be applied
263            */
264            public static void deleteLayout(long groupId, boolean privateLayout,
265                    long layoutId, com.liferay.portal.service.ServiceContext serviceContext)
266                    throws com.liferay.portal.kernel.exception.PortalException {
267                    getService()
268                            .deleteLayout(groupId, privateLayout, layoutId, serviceContext);
269            }
270    
271            /**
272            * Deletes the layout from the database. Also notifies the appropriate model listeners.
273            *
274            * @param layout the layout
275            * @return the layout that was removed
276            */
277            public static com.liferay.portal.model.Layout deleteLayout(
278                    com.liferay.portal.model.Layout layout) {
279                    return getService().deleteLayout(layout);
280            }
281    
282            /**
283            * Deletes the layout, its child layouts, and its associated resources.
284            *
285            * @param layout the layout
286            * @param updateLayoutSet whether the layout set's page counter needs to be
287            updated
288            * @param serviceContext the service context to be applied
289            */
290            public static void deleteLayout(com.liferay.portal.model.Layout layout,
291                    boolean updateLayoutSet,
292                    com.liferay.portal.service.ServiceContext serviceContext)
293                    throws com.liferay.portal.kernel.exception.PortalException {
294                    getService().deleteLayout(layout, updateLayoutSet, serviceContext);
295            }
296    
297            /**
298            * Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners.
299            *
300            * @param plid the primary key of the layout
301            * @return the layout that was removed
302            * @throws PortalException if a layout with the primary key could not be found
303            */
304            public static com.liferay.portal.model.Layout deleteLayout(long plid)
305                    throws com.liferay.portal.kernel.exception.PortalException {
306                    return getService().deleteLayout(plid);
307            }
308    
309            /**
310            * Deletes the layout with the plid, also deleting the layout's child
311            * layouts, and associated resources.
312            *
313            * @param plid the primary key of the layout
314            * @param serviceContext the service context to be applied
315            */
316            public static void deleteLayout(long plid,
317                    com.liferay.portal.service.ServiceContext serviceContext)
318                    throws com.liferay.portal.kernel.exception.PortalException {
319                    getService().deleteLayout(plid, serviceContext);
320            }
321    
322            /**
323            * Deletes the group's private or non-private layouts, also deleting the
324            * layouts' child layouts, and associated resources.
325            *
326            * @param groupId the primary key of the group
327            * @param privateLayout whether the layout is private to the group
328            * @param serviceContext the service context to be applied. The parent
329            layout set's page count will be updated by default, unless an
330            attribute named <code>updatePageCount</code> is set to
331            <code>false</code>.
332            */
333            public static void deleteLayouts(long groupId, boolean privateLayout,
334                    com.liferay.portal.service.ServiceContext serviceContext)
335                    throws com.liferay.portal.kernel.exception.PortalException {
336                    getService().deleteLayouts(groupId, privateLayout, serviceContext);
337            }
338    
339            /**
340            * @throws PortalException
341            */
342            public static com.liferay.portal.model.PersistedModel deletePersistedModel(
343                    com.liferay.portal.model.PersistedModel persistedModel)
344                    throws com.liferay.portal.kernel.exception.PortalException {
345                    return getService().deletePersistedModel(persistedModel);
346            }
347    
348            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
349                    return getService().dynamicQuery();
350            }
351    
352            /**
353            * Performs a dynamic query on the database and returns the matching rows.
354            *
355            * @param dynamicQuery the dynamic query
356            * @return the matching rows
357            */
358            public static <T> java.util.List<T> dynamicQuery(
359                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
360                    return getService().dynamicQuery(dynamicQuery);
361            }
362    
363            /**
364            * Performs a dynamic query on the database and returns a range of the matching rows.
365            *
366            * <p>
367            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
368            * </p>
369            *
370            * @param dynamicQuery the dynamic query
371            * @param start the lower bound of the range of model instances
372            * @param end the upper bound of the range of model instances (not inclusive)
373            * @return the range of matching rows
374            */
375            public static <T> java.util.List<T> dynamicQuery(
376                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
377                    int end) {
378                    return getService().dynamicQuery(dynamicQuery, start, end);
379            }
380    
381            /**
382            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
383            *
384            * <p>
385            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
386            * </p>
387            *
388            * @param dynamicQuery the dynamic query
389            * @param start the lower bound of the range of model instances
390            * @param end the upper bound of the range of model instances (not inclusive)
391            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
392            * @return the ordered range of matching rows
393            */
394            public static <T> java.util.List<T> dynamicQuery(
395                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
396                    int end,
397                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
398                    return getService()
399                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
400            }
401    
402            /**
403            * Returns the number of rows matching the dynamic query.
404            *
405            * @param dynamicQuery the dynamic query
406            * @return the number of rows matching the dynamic query
407            */
408            public static long dynamicQueryCount(
409                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
410                    return getService().dynamicQueryCount(dynamicQuery);
411            }
412    
413            /**
414            * Returns the number of rows matching the dynamic query.
415            *
416            * @param dynamicQuery the dynamic query
417            * @param projection the projection to apply to the query
418            * @return the number of rows matching the dynamic query
419            */
420            public static long dynamicQueryCount(
421                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
422                    com.liferay.portal.kernel.dao.orm.Projection projection) {
423                    return getService().dynamicQueryCount(dynamicQuery, projection);
424            }
425    
426            /**
427            * Exports layouts with the primary keys and criteria as a byte array.
428            *
429            * @param groupId the primary key of the group
430            * @param privateLayout whether the layout is private to the group
431            * @param layoutIds the primary keys of the layouts to be exported
432            * @param parameterMap the mapping of parameters indicating which
433            information to export. For information on the keys used in
434            the map see {@link
435            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
436            * @param startDate the export's start date
437            * @param endDate the export's end date
438            * @return the layouts as a byte array
439            * @throws PortalException
440            * @deprecated As of 7.0.0, with no direct replacement
441            */
442            @Deprecated
443            public static byte[] exportLayouts(long groupId, boolean privateLayout,
444                    long[] layoutIds,
445                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
446                    java.util.Date startDate, java.util.Date endDate)
447                    throws com.liferay.portal.kernel.exception.PortalException {
448                    return getService()
449                                       .exportLayouts(groupId, privateLayout, layoutIds,
450                            parameterMap, startDate, endDate);
451            }
452    
453            /**
454            * Exports all layouts that match the criteria as a byte array.
455            *
456            * @param groupId the primary key of the group
457            * @param privateLayout whether the layout is private to the group
458            * @param parameterMap the mapping of parameters indicating which
459            information to export. For information on the keys used in
460            the map see {@link
461            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
462            * @param startDate the export's start date
463            * @param endDate the export's end date
464            * @return the layout as a byte array
465            * @throws PortalException
466            * @deprecated As of 7.0.0, with no direct replacement
467            */
468            @Deprecated
469            public static byte[] exportLayouts(long groupId, boolean privateLayout,
470                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
471                    java.util.Date startDate, java.util.Date endDate)
472                    throws com.liferay.portal.kernel.exception.PortalException {
473                    return getService()
474                                       .exportLayouts(groupId, privateLayout, parameterMap,
475                            startDate, endDate);
476            }
477    
478            /**
479            * @throws PortalException
480            * @deprecated As of 7.0.0, replaced by {@link
481            com.liferay.portlet.exportimport.service.ExportImportLocalService#exportLayoutsAsFile(
482            ExportImportConfiguration)}
483            */
484            @Deprecated
485            public static java.io.File exportLayoutsAsFile(
486                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration)
487                    throws com.liferay.portal.kernel.exception.PortalException {
488                    return getService().exportLayoutsAsFile(exportImportConfiguration);
489            }
490    
491            /**
492            * Exports the layouts that match the primary keys and criteria as a file.
493            *
494            * @param groupId the primary key of the group
495            * @param privateLayout whether the layout is private to the group
496            * @param layoutIds the primary keys of the layouts to be exported
497            (optionally <code>null</code>)
498            * @param parameterMap the mapping of parameters indicating which
499            information to export. For information on the keys used in
500            the map see {@link
501            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
502            * @param startDate the export's start date
503            * @param endDate the export's end date
504            * @return the layouts as a File
505            * @throws PortalException
506            * @deprecated As of 7.0.0, with no direct replacement
507            */
508            @Deprecated
509            public static java.io.File exportLayoutsAsFile(long groupId,
510                    boolean privateLayout, long[] layoutIds,
511                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
512                    java.util.Date startDate, java.util.Date endDate)
513                    throws com.liferay.portal.kernel.exception.PortalException {
514                    return getService()
515                                       .exportLayoutsAsFile(groupId, privateLayout, layoutIds,
516                            parameterMap, startDate, endDate);
517            }
518    
519            /**
520            * @throws PortalException
521            * @deprecated As of 7.0.0, replaced by {@link
522            com.liferay.portlet.exportimport.service.ExportImportLocalService#exportLayoutsAsFileInBackground(
523            long, ExportImportConfiguration)}
524            */
525            @Deprecated
526            public static long exportLayoutsAsFileInBackground(long userId,
527                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration)
528                    throws com.liferay.portal.kernel.exception.PortalException {
529                    return getService()
530                                       .exportLayoutsAsFileInBackground(userId,
531                            exportImportConfiguration);
532            }
533    
534            /**
535            * @throws PortalException
536            * @deprecated As of 7.0.0, replaced by {@link
537            com.liferay.portlet.exportimport.service.ExportImportLocalService#exportLayoutsAsFileInBackground(
538            long, long)}
539            */
540            @Deprecated
541            public static long exportLayoutsAsFileInBackground(long userId,
542                    long exportImportConfigurationId)
543                    throws com.liferay.portal.kernel.exception.PortalException {
544                    return getService()
545                                       .exportLayoutsAsFileInBackground(userId,
546                            exportImportConfigurationId);
547            }
548    
549            /**
550            * @throws PortalException
551            * @deprecated As of 7.0.0, with no direct replacement
552            */
553            @Deprecated
554            public static long exportLayoutsAsFileInBackground(long userId,
555                    java.lang.String taskName, long groupId, boolean privateLayout,
556                    long[] layoutIds,
557                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
558                    java.util.Date startDate, java.util.Date endDate)
559                    throws com.liferay.portal.kernel.exception.PortalException {
560                    return getService()
561                                       .exportLayoutsAsFileInBackground(userId, taskName, groupId,
562                            privateLayout, layoutIds, parameterMap, startDate, endDate);
563            }
564    
565            /**
566            * @throws PortalException
567            * @deprecated As of 7.0.0, with no direct replacement
568            */
569            @Deprecated
570            public static long exportLayoutsAsFileInBackground(long userId,
571                    java.lang.String taskName, long groupId, boolean privateLayout,
572                    long[] layoutIds,
573                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
574                    java.util.Date startDate, java.util.Date endDate,
575                    java.lang.String fileName)
576                    throws com.liferay.portal.kernel.exception.PortalException {
577                    return getService()
578                                       .exportLayoutsAsFileInBackground(userId, taskName, groupId,
579                            privateLayout, layoutIds, parameterMap, startDate, endDate, fileName);
580            }
581    
582            /**
583            * @throws PortalException
584            * @deprecated As of 7.0.0, with no direct replacement
585            */
586            @Deprecated
587            public static byte[] exportPortletInfo(long companyId,
588                    java.lang.String portletId,
589                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
590                    java.util.Date startDate, java.util.Date endDate)
591                    throws com.liferay.portal.kernel.exception.PortalException {
592                    return getService()
593                                       .exportPortletInfo(companyId, portletId, parameterMap,
594                            startDate, endDate);
595            }
596    
597            /**
598            * Exports the portlet information (categories, permissions, ... etc.) as a
599            * byte array.
600            *
601            * @param plid the primary key of the layout
602            * @param groupId the primary key of the group
603            * @param portletId the primary key of the portlet
604            * @param parameterMap the mapping of parameters indicating which
605            information to export. For information on the keys used in
606            the map see {@link
607            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
608            * @param startDate the export's start date
609            * @param endDate the export's end date
610            * @return the portlet information as a byte array
611            * @throws PortalException
612            * @deprecated As of 7.0.0, with no direct replacement
613            */
614            @Deprecated
615            public static byte[] exportPortletInfo(long plid, long groupId,
616                    java.lang.String portletId,
617                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
618                    java.util.Date startDate, java.util.Date endDate)
619                    throws com.liferay.portal.kernel.exception.PortalException {
620                    return getService()
621                                       .exportPortletInfo(plid, groupId, portletId, parameterMap,
622                            startDate, endDate);
623            }
624    
625            /**
626            * @throws PortalException
627            * @deprecated As of 7.0.0, with no direct replacement
628            */
629            @Deprecated
630            public static java.io.File exportPortletInfoAsFile(long companyId,
631                    java.lang.String portletId,
632                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
633                    java.util.Date startDate, java.util.Date endDate)
634                    throws com.liferay.portal.kernel.exception.PortalException {
635                    return getService()
636                                       .exportPortletInfoAsFile(companyId, portletId, parameterMap,
637                            startDate, endDate);
638            }
639    
640            /**
641            * @throws PortalException
642            * @deprecated As of 7.0.0, replaced by {@link
643            com.liferay.portlet.exportimport.service.ExportImportLocalService#exportPortletInfoAsFile(
644            ExportImportConfiguration)}}
645            */
646            @Deprecated
647            public static java.io.File exportPortletInfoAsFile(
648                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration)
649                    throws com.liferay.portal.kernel.exception.PortalException {
650                    return getService().exportPortletInfoAsFile(exportImportConfiguration);
651            }
652    
653            /**
654            * Exports the portlet information (categories, permissions, ... etc.) as a
655            * file.
656            *
657            * @param plid the primary key of the layout
658            * @param groupId the primary key of the group
659            * @param portletId the primary key of the portlet
660            * @param parameterMap the mapping of parameters indicating which
661            information to export. For information on the keys used in
662            the map see {@link
663            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
664            * @param startDate the export's start date
665            * @param endDate the export's end date
666            * @return the portlet information as a file
667            * @throws PortalException
668            * @deprecated As of 7.0.0, with no direct replacement
669            */
670            @Deprecated
671            public static java.io.File exportPortletInfoAsFile(long plid, long groupId,
672                    java.lang.String portletId,
673                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
674                    java.util.Date startDate, java.util.Date endDate)
675                    throws com.liferay.portal.kernel.exception.PortalException {
676                    return getService()
677                                       .exportPortletInfoAsFile(plid, groupId, portletId,
678                            parameterMap, startDate, endDate);
679            }
680    
681            /**
682            * @throws PortalException
683            * @deprecated As of 7.0.0, replaced by {@link
684            com.liferay.portlet.exportimport.service.ExportImportLocalService#exportPortletInfoAsFileInBackground(
685            long, ExportImportConfiguration)}}
686            */
687            @Deprecated
688            public static long exportPortletInfoAsFileInBackground(long userId,
689                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration)
690                    throws com.liferay.portal.kernel.exception.PortalException {
691                    return getService()
692                                       .exportPortletInfoAsFileInBackground(userId,
693                            exportImportConfiguration);
694            }
695    
696            /**
697            * @throws PortalException
698            * @deprecated As of 7.0.0, replaced by {@link
699            com.liferay.portlet.exportimport.service.ExportImportLocalService#exportPortletInfoAsFileInBackground(
700            long, long)}}
701            */
702            @Deprecated
703            public static long exportPortletInfoAsFileInBackground(long userId,
704                    long exportImportConfigurationId)
705                    throws com.liferay.portal.kernel.exception.PortalException {
706                    return getService()
707                                       .exportPortletInfoAsFileInBackground(userId,
708                            exportImportConfigurationId);
709            }
710    
711            /**
712            * @throws PortalException
713            * @deprecated As of 7.0.0, with no direct replacement
714            */
715            @Deprecated
716            public static long exportPortletInfoAsFileInBackground(long userId,
717                    java.lang.String taskName, long plid, long groupId,
718                    java.lang.String portletId,
719                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
720                    java.util.Date startDate, java.util.Date endDate,
721                    java.lang.String fileName)
722                    throws com.liferay.portal.kernel.exception.PortalException {
723                    return getService()
724                                       .exportPortletInfoAsFileInBackground(userId, taskName, plid,
725                            groupId, portletId, parameterMap, startDate, endDate, fileName);
726            }
727    
728            /**
729            * @throws PortalException
730            * @deprecated As of 7.0.0, with no direct replacement
731            */
732            @Deprecated
733            public static long exportPortletInfoAsFileInBackground(long userId,
734                    java.lang.String taskName, java.lang.String portletId,
735                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
736                    java.util.Date startDate, java.util.Date endDate,
737                    java.lang.String fileName)
738                    throws com.liferay.portal.kernel.exception.PortalException {
739                    return getService()
740                                       .exportPortletInfoAsFileInBackground(userId, taskName,
741                            portletId, parameterMap, startDate, endDate, fileName);
742            }
743    
744            public static com.liferay.portal.model.Layout fetchFirstLayout(
745                    long groupId, boolean privateLayout, long parentLayoutId) {
746                    return getService()
747                                       .fetchFirstLayout(groupId, privateLayout, parentLayoutId);
748            }
749    
750            public static com.liferay.portal.model.Layout fetchLayout(long groupId,
751                    boolean privateLayout, long layoutId) {
752                    return getService().fetchLayout(groupId, privateLayout, layoutId);
753            }
754    
755            public static com.liferay.portal.model.Layout fetchLayout(long plid) {
756                    return getService().fetchLayout(plid);
757            }
758    
759            public static com.liferay.portal.model.Layout fetchLayoutByFriendlyURL(
760                    long groupId, boolean privateLayout, java.lang.String friendlyURL) {
761                    return getService()
762                                       .fetchLayoutByFriendlyURL(groupId, privateLayout, friendlyURL);
763            }
764    
765            /**
766            * Returns the layout matching the UUID, group, and privacy.
767            *
768            * @param uuid the layout's UUID
769            * @param groupId the primary key of the group
770            * @param privateLayout whether the layout is private to the group
771            * @return the matching layout, or <code>null</code> if a matching layout could not be found
772            */
773            public static com.liferay.portal.model.Layout fetchLayoutByUuidAndGroupId(
774                    java.lang.String uuid, long groupId, boolean privateLayout) {
775                    return getService()
776                                       .fetchLayoutByUuidAndGroupId(uuid, groupId, privateLayout);
777            }
778    
779            public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
780                    return getService().getActionableDynamicQuery();
781            }
782    
783            /**
784            * Returns the primary key of the default layout for the group
785            *
786            * @param groupId the primary key of the group
787            * @return the primary key of the default layout for the group (optionally
788            {@link LayoutConstants#DEFAULT_PLID})
789            */
790            public static long getDefaultPlid(long groupId) {
791                    return getService().getDefaultPlid(groupId);
792            }
793    
794            /**
795            * Returns primary key of the matching default layout for the group
796            *
797            * @param groupId the primary key of the group
798            * @param privateLayout whether the layout is private to the group
799            * @return the primary key of the default layout for the group; {@link
800            LayoutConstants#DEFAULT_PLID}) otherwise
801            */
802            public static long getDefaultPlid(long groupId, boolean privateLayout) {
803                    return getService().getDefaultPlid(groupId, privateLayout);
804            }
805    
806            /**
807            * Returns primary key of the default portlet layout for the group
808            *
809            * @param groupId the primary key of the group
810            * @param privateLayout whether the layout is private to the group
811            * @param portletId the primary key of the portlet
812            * @return the primary key of the default portlet layout for the group;
813            {@link LayoutConstants#DEFAULT_PLID} otherwise
814            * @throws PortalException
815            */
816            public static long getDefaultPlid(long groupId, boolean privateLayout,
817                    java.lang.String portletId)
818                    throws com.liferay.portal.kernel.exception.PortalException {
819                    return getService().getDefaultPlid(groupId, privateLayout, portletId);
820            }
821    
822            public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
823                    com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext) {
824                    return getService().getExportActionableDynamicQuery(portletDataContext);
825            }
826    
827            /**
828            * Returns the layout for the friendly URL
829            *
830            * @param groupId the primary key of the group
831            * @param privateLayout whether the layout is private to the group
832            * @param friendlyURL the friendly URL of the layout
833            * @return the layout for the friendly URL
834            */
835            public static com.liferay.portal.model.Layout getFriendlyURLLayout(
836                    long groupId, boolean privateLayout, java.lang.String friendlyURL)
837                    throws com.liferay.portal.kernel.exception.PortalException {
838                    return getService()
839                                       .getFriendlyURLLayout(groupId, privateLayout, friendlyURL);
840            }
841    
842            public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() {
843                    return getService().getIndexableActionableDynamicQuery();
844            }
845    
846            /**
847            * Returns the layout matching the primary key, group, and privacy; throws a
848            * {@link NoSuchLayoutException} otherwise.
849            *
850            * @param groupId the primary key of the group
851            * @param privateLayout whether the layout is private to the group
852            * @param layoutId the primary key of the layout
853            * @return the matching layout
854            */
855            public static com.liferay.portal.model.Layout getLayout(long groupId,
856                    boolean privateLayout, long layoutId)
857                    throws com.liferay.portal.kernel.exception.PortalException {
858                    return getService().getLayout(groupId, privateLayout, layoutId);
859            }
860    
861            /**
862            * Returns the layout with the primary key.
863            *
864            * @param plid the primary key of the layout
865            * @return the layout
866            * @throws PortalException if a layout with the primary key could not be found
867            */
868            public static com.liferay.portal.model.Layout getLayout(long plid)
869                    throws com.liferay.portal.kernel.exception.PortalException {
870                    return getService().getLayout(plid);
871            }
872    
873            /**
874            * Returns the layout for the icon image; throws a {@link
875            * NoSuchLayoutException} otherwise.
876            *
877            * @param iconImageId the primary key of the icon image
878            * @return Returns the layout for the icon image
879            */
880            public static com.liferay.portal.model.Layout getLayoutByIconImageId(
881                    long iconImageId)
882                    throws com.liferay.portal.kernel.exception.PortalException {
883                    return getService().getLayoutByIconImageId(iconImageId);
884            }
885    
886            /**
887            * Returns the layout matching the UUID, group, and privacy.
888            *
889            * @param uuid the layout's UUID
890            * @param groupId the primary key of the group
891            * @param privateLayout whether the layout is private to the group
892            * @return the matching layout
893            * @throws PortalException if a matching layout could not be found
894            */
895            public static com.liferay.portal.model.Layout getLayoutByUuidAndGroupId(
896                    java.lang.String uuid, long groupId, boolean privateLayout)
897                    throws com.liferay.portal.kernel.exception.PortalException {
898                    return getService()
899                                       .getLayoutByUuidAndGroupId(uuid, groupId, privateLayout);
900            }
901    
902            /**
903            * Returns the layout references for all the layouts that belong to the
904            * company and belong to the portlet that matches the preferences.
905            *
906            * @param companyId the primary key of the company
907            * @param portletId the primary key of the portlet
908            * @param preferencesKey the portlet's preference key
909            * @param preferencesValue the portlet's preference value
910            * @return the layout references of the matching layouts
911            */
912            public static com.liferay.portal.model.LayoutReference[] getLayouts(
913                    long companyId, java.lang.String portletId,
914                    java.lang.String preferencesKey, java.lang.String preferencesValue) {
915                    return getService()
916                                       .getLayouts(companyId, portletId, preferencesKey,
917                            preferencesValue);
918            }
919    
920            /**
921            * Returns all the layouts belonging to the group.
922            *
923            * @param groupId the primary key of the group
924            * @param privateLayout whether the layout is private to the group
925            * @return the matching layouts, or <code>null</code> if no matches were
926            found
927            */
928            public static java.util.List<com.liferay.portal.model.Layout> getLayouts(
929                    long groupId, boolean privateLayout) {
930                    return getService().getLayouts(groupId, privateLayout);
931            }
932    
933            /**
934            * Returns all the layouts that match the layout IDs and belong to the
935            * group.
936            *
937            * @param groupId the primary key of the group
938            * @param privateLayout whether the layout is private to the group
939            * @param layoutIds the primary keys of the layouts
940            * @return the matching layouts, or an empty list if no matches were found
941            */
942            public static java.util.List<com.liferay.portal.model.Layout> getLayouts(
943                    long groupId, boolean privateLayout, long[] layoutIds)
944                    throws com.liferay.portal.kernel.exception.PortalException {
945                    return getService().getLayouts(groupId, privateLayout, layoutIds);
946            }
947    
948            /**
949            * Returns all the layouts belonging to the group that are children of the
950            * parent layout.
951            *
952            * @param groupId the primary key of the group
953            * @param privateLayout whether the layout is private to the group
954            * @param parentLayoutId the primary key of the parent layout
955            * @return the matching layouts, or <code>null</code> if no matches were
956            found
957            */
958            public static java.util.List<com.liferay.portal.model.Layout> getLayouts(
959                    long groupId, boolean privateLayout, long parentLayoutId) {
960                    return getService().getLayouts(groupId, privateLayout, parentLayoutId);
961            }
962    
963            /**
964            * Returns a range of all the layouts belonging to the group that are
965            * children of the parent layout.
966            *
967            * <p>
968            * Useful when paginating results. Returns a maximum of <code>end -
969            * start</code> instances. <code>start</code> and <code>end</code> are not
970            * primary keys, they are indexes in the result set. Thus, <code>0</code>
971            * refers to the first result in the set. Setting both <code>start</code>
972            * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full
973            * result set.
974            * </p>
975            *
976            * @param groupId the primary key of the group
977            * @param privateLayout whether the layout is private to the group
978            * @param parentLayoutId the primary key of the parent layout
979            * @param incomplete whether the layout is incomplete
980            * @param start the lower bound of the range of layouts
981            * @param end the upper bound of the range of layouts (not inclusive)
982            * @return the matching layouts, or <code>null</code> if no matches were
983            found
984            */
985            public static java.util.List<com.liferay.portal.model.Layout> getLayouts(
986                    long groupId, boolean privateLayout, long parentLayoutId,
987                    boolean incomplete, int start, int end) {
988                    return getService()
989                                       .getLayouts(groupId, privateLayout, parentLayoutId,
990                            incomplete, start, end);
991            }
992    
993            /**
994            * Returns all the layouts that match the type and belong to the group.
995            *
996            * @param groupId the primary key of the group
997            * @param privateLayout whether the layout is private to the group
998            * @param type the type of the layouts (optionally {@link
999            LayoutConstants#TYPE_PORTLET})
1000            * @return the matching layouts, or <code>null</code> if no matches were
1001            found
1002            */
1003            public static java.util.List<com.liferay.portal.model.Layout> getLayouts(
1004                    long groupId, boolean privateLayout, java.lang.String type) {
1005                    return getService().getLayouts(groupId, privateLayout, type);
1006            }
1007    
1008            /**
1009            * Returns a range of all the layouts.
1010            *
1011            * <p>
1012            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
1013            * </p>
1014            *
1015            * @param start the lower bound of the range of layouts
1016            * @param end the upper bound of the range of layouts (not inclusive)
1017            * @return the range of layouts
1018            */
1019            public static java.util.List<com.liferay.portal.model.Layout> getLayouts(
1020                    int start, int end) {
1021                    return getService().getLayouts(start, end);
1022            }
1023    
1024            public static java.util.List<com.liferay.portal.model.Layout> getLayoutsByLayoutPrototypeUuid(
1025                    java.lang.String layoutPrototypeUuid) {
1026                    return getService().getLayoutsByLayoutPrototypeUuid(layoutPrototypeUuid);
1027            }
1028    
1029            public static int getLayoutsByLayoutPrototypeUuidCount(
1030                    java.lang.String layoutPrototypeUuid) {
1031                    return getService()
1032                                       .getLayoutsByLayoutPrototypeUuidCount(layoutPrototypeUuid);
1033            }
1034    
1035            /**
1036            * Returns all the layouts matching the UUID and company.
1037            *
1038            * @param uuid the UUID of the layouts
1039            * @param companyId the primary key of the company
1040            * @return the matching layouts, or an empty list if no matches were found
1041            */
1042            public static java.util.List<com.liferay.portal.model.Layout> getLayoutsByUuidAndCompanyId(
1043                    java.lang.String uuid, long companyId) {
1044                    return getService().getLayoutsByUuidAndCompanyId(uuid, companyId);
1045            }
1046    
1047            /**
1048            * Returns a range of layouts matching the UUID and company.
1049            *
1050            * @param uuid the UUID of the layouts
1051            * @param companyId the primary key of the company
1052            * @param start the lower bound of the range of layouts
1053            * @param end the upper bound of the range of layouts (not inclusive)
1054            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
1055            * @return the range of matching layouts, or an empty list if no matches were found
1056            */
1057            public static java.util.List<com.liferay.portal.model.Layout> getLayoutsByUuidAndCompanyId(
1058                    java.lang.String uuid, long companyId, int start, int end,
1059                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Layout> orderByComparator) {
1060                    return getService()
1061                                       .getLayoutsByUuidAndCompanyId(uuid, companyId, start, end,
1062                            orderByComparator);
1063            }
1064    
1065            /**
1066            * Returns the number of layouts.
1067            *
1068            * @return the number of layouts
1069            */
1070            public static int getLayoutsCount() {
1071                    return getService().getLayoutsCount();
1072            }
1073    
1074            public static int getLayoutsCount(com.liferay.portal.model.Group group,
1075                    boolean privateLayout)
1076                    throws com.liferay.portal.kernel.exception.PortalException {
1077                    return getService().getLayoutsCount(group, privateLayout);
1078            }
1079    
1080            public static int getLayoutsCount(com.liferay.portal.model.Group group,
1081                    boolean privateLayout, boolean includeUserGroups)
1082                    throws com.liferay.portal.kernel.exception.PortalException {
1083                    return getService()
1084                                       .getLayoutsCount(group, privateLayout, includeUserGroups);
1085            }
1086    
1087            public static int getLayoutsCount(com.liferay.portal.model.Group group,
1088                    boolean privateLayout, long parentLayoutId) {
1089                    return getService().getLayoutsCount(group, privateLayout, parentLayoutId);
1090            }
1091    
1092            public static int getLayoutsCount(com.liferay.portal.model.User user,
1093                    boolean privateLayout)
1094                    throws com.liferay.portal.kernel.exception.PortalException {
1095                    return getService().getLayoutsCount(user, privateLayout);
1096            }
1097    
1098            public static int getLayoutsCount(com.liferay.portal.model.User user,
1099                    boolean privateLayout, boolean includeUserGroups)
1100                    throws com.liferay.portal.kernel.exception.PortalException {
1101                    return getService()
1102                                       .getLayoutsCount(user, privateLayout, includeUserGroups);
1103            }
1104    
1105            /**
1106            * Returns the primary key to use for the next layout.
1107            *
1108            * @param groupId the primary key of the group
1109            * @param privateLayout whether the layout is private to the group
1110            * @return the primary key to use for the next layout
1111            */
1112            public static long getNextLayoutId(long groupId, boolean privateLayout) {
1113                    return getService().getNextLayoutId(groupId, privateLayout);
1114            }
1115    
1116            /**
1117            * Returns all the layouts without resource permissions
1118            *
1119            * @param roleId the primary key of the role
1120            * @return all the layouts without resource permissions
1121            */
1122            public static java.util.List<com.liferay.portal.model.Layout> getNoPermissionLayouts(
1123                    long roleId) {
1124                    return getService().getNoPermissionLayouts(roleId);
1125            }
1126    
1127            /**
1128            * Returns all the layouts whose friendly URLs are <code>null</code>
1129            *
1130            * @return all the layouts whose friendly URLs are <code>null</code>
1131            */
1132            public static java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts() {
1133                    return getService().getNullFriendlyURLLayouts();
1134            }
1135    
1136            /**
1137            * Returns the OSGi service identifier.
1138            *
1139            * @return the OSGi service identifier
1140            */
1141            public static java.lang.String getOSGiServiceIdentifier() {
1142                    return getService().getOSGiServiceIdentifier();
1143            }
1144    
1145            public static com.liferay.portal.model.Layout getParentLayout(
1146                    com.liferay.portal.model.Layout layout)
1147                    throws com.liferay.portal.kernel.exception.PortalException {
1148                    return getService().getParentLayout(layout);
1149            }
1150    
1151            public static com.liferay.portal.model.PersistedModel getPersistedModel(
1152                    java.io.Serializable primaryKeyObj)
1153                    throws com.liferay.portal.kernel.exception.PortalException {
1154                    return getService().getPersistedModel(primaryKeyObj);
1155            }
1156    
1157            /**
1158            * Returns all the layouts within scope of the group
1159            *
1160            * @param groupId the primary key of the group
1161            * @param privateLayout whether the layout is private to the group
1162            * @return the layouts within scope of the group
1163            */
1164            public static java.util.List<com.liferay.portal.model.Layout> getScopeGroupLayouts(
1165                    long groupId, boolean privateLayout) {
1166                    return getService().getScopeGroupLayouts(groupId, privateLayout);
1167            }
1168    
1169            public static boolean hasLayoutSetPrototypeLayout(
1170                    long layoutSetPrototypeId, java.lang.String layoutUuid)
1171                    throws com.liferay.portal.kernel.exception.PortalException {
1172                    return getService()
1173                                       .hasLayoutSetPrototypeLayout(layoutSetPrototypeId, layoutUuid);
1174            }
1175    
1176            public static boolean hasLayoutSetPrototypeLayout(
1177                    java.lang.String layoutSetPrototypeUuid, long companyId,
1178                    java.lang.String layoutUuid)
1179                    throws com.liferay.portal.kernel.exception.PortalException {
1180                    return getService()
1181                                       .hasLayoutSetPrototypeLayout(layoutSetPrototypeUuid,
1182                            companyId, layoutUuid);
1183            }
1184    
1185            public static boolean hasLayouts(com.liferay.portal.model.Group group)
1186                    throws com.liferay.portal.kernel.exception.PortalException {
1187                    return getService().hasLayouts(group);
1188            }
1189    
1190            public static boolean hasLayouts(com.liferay.portal.model.Group group,
1191                    boolean privateLayout)
1192                    throws com.liferay.portal.kernel.exception.PortalException {
1193                    return getService().hasLayouts(group, privateLayout);
1194            }
1195    
1196            public static boolean hasLayouts(com.liferay.portal.model.Group group,
1197                    boolean privateLayout, boolean includeUserGroups)
1198                    throws com.liferay.portal.kernel.exception.PortalException {
1199                    return getService().hasLayouts(group, privateLayout, includeUserGroups);
1200            }
1201    
1202            /**
1203            * Returns <code>true</code> if the group has any layouts;
1204            * <code>false</code> otherwise.
1205            *
1206            * @param groupId the primary key of the group
1207            * @param privateLayout whether the layout is private to the group
1208            * @param parentLayoutId the primary key of the parent layout
1209            * @return <code>true</code> if the group has any layouts;
1210            <code>false</code> otherwise
1211            */
1212            public static boolean hasLayouts(long groupId, boolean privateLayout,
1213                    long parentLayoutId) {
1214                    return getService().hasLayouts(groupId, privateLayout, parentLayoutId);
1215            }
1216    
1217            public static boolean hasLayouts(com.liferay.portal.model.User user,
1218                    boolean privateLayout)
1219                    throws com.liferay.portal.kernel.exception.PortalException {
1220                    return getService().hasLayouts(user, privateLayout);
1221            }
1222    
1223            public static boolean hasLayouts(com.liferay.portal.model.User user,
1224                    boolean privateLayout, boolean includeUserGroups)
1225                    throws com.liferay.portal.kernel.exception.PortalException {
1226                    return getService().hasLayouts(user, privateLayout, includeUserGroups);
1227            }
1228    
1229            /**
1230            * @throws PortalException
1231            * @deprecated As of 7.0.0, replaced by {@link
1232            com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayouts(
1233            ExportImportConfiguration, File)}}
1234            */
1235            @Deprecated
1236            public static void importLayouts(
1237                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1238                    java.io.File file)
1239                    throws com.liferay.portal.kernel.exception.PortalException {
1240                    getService().importLayouts(exportImportConfiguration, file);
1241            }
1242    
1243            /**
1244            * @throws PortalException
1245            * @deprecated As of 7.0.0, replaced by {@link
1246            com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayouts(
1247            ExportImportConfiguration, InputStream)}}
1248            */
1249            @Deprecated
1250            public static void importLayouts(
1251                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1252                    java.io.InputStream is)
1253                    throws com.liferay.portal.kernel.exception.PortalException {
1254                    getService().importLayouts(exportImportConfiguration, is);
1255            }
1256    
1257            /**
1258            * Imports the layouts from the byte array.
1259            *
1260            * @param userId the primary key of the user
1261            * @param groupId the primary key of the group
1262            * @param privateLayout whether the layout is private to the group
1263            * @param parameterMap the mapping of parameters indicating which
1264            information will be imported. For information on the keys
1265            used in the map see {@link
1266            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
1267            * @param bytes the byte array with the data
1268            * @throws PortalException
1269            * @see com.liferay.portlet.exportimport.lar.LayoutImporter
1270            * @deprecated As of 7.0.0, with no direct replacement
1271            */
1272            @Deprecated
1273            public static void importLayouts(long userId, long groupId,
1274                    boolean privateLayout,
1275                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1276                    byte[] bytes)
1277                    throws com.liferay.portal.kernel.exception.PortalException {
1278                    getService()
1279                            .importLayouts(userId, groupId, privateLayout, parameterMap, bytes);
1280            }
1281    
1282            /**
1283            * Imports the layouts from the file.
1284            *
1285            * @param userId the primary key of the user
1286            * @param groupId the primary key of the group
1287            * @param privateLayout whether the layout is private to the group
1288            * @param parameterMap the mapping of parameters indicating which
1289            information will be imported. For information on the keys
1290            used in the map see {@link
1291            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
1292            * @param file the LAR file with the data
1293            * @throws PortalException
1294            * @see com.liferay.portlet.exportimport.lar.LayoutImporter
1295            * @deprecated As of 7.0.0, with no direct replacement
1296            */
1297            @Deprecated
1298            public static void importLayouts(long userId, long groupId,
1299                    boolean privateLayout,
1300                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1301                    java.io.File file)
1302                    throws com.liferay.portal.kernel.exception.PortalException {
1303                    getService()
1304                            .importLayouts(userId, groupId, privateLayout, parameterMap, file);
1305            }
1306    
1307            /**
1308            * Imports the layouts from the input stream.
1309            *
1310            * @param userId the primary key of the user
1311            * @param groupId the primary key of the group
1312            * @param privateLayout whether the layout is private to the group
1313            * @param parameterMap the mapping of parameters indicating which
1314            information will be imported. For information on the keys
1315            used in the map see {@link
1316            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
1317            * @param is the input stream
1318            * @throws PortalException
1319            * @see com.liferay.portlet.exportimport.lar.LayoutImporter
1320            * @deprecated As of 7.0.0, with no direct replacement
1321            */
1322            @Deprecated
1323            public static void importLayouts(long userId, long groupId,
1324                    boolean privateLayout,
1325                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1326                    java.io.InputStream is)
1327                    throws com.liferay.portal.kernel.exception.PortalException {
1328                    getService()
1329                            .importLayouts(userId, groupId, privateLayout, parameterMap, is);
1330            }
1331    
1332            /**
1333            * @throws PortalException
1334            * @deprecated As of 7.0.0, replaced by {@link
1335            com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayoutsDataDeletions(
1336            ExportImportConfiguration, File)}
1337            */
1338            @Deprecated
1339            public static void importLayoutsDataDeletions(
1340                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1341                    java.io.File file)
1342                    throws com.liferay.portal.kernel.exception.PortalException {
1343                    getService().importLayoutsDataDeletions(exportImportConfiguration, file);
1344            }
1345    
1346            /**
1347            * @throws PortalException
1348            * @deprecated As of 7.0.0, replaced by {@link
1349            com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayoutsInBackground(
1350            long, ExportImportConfiguration, File)}
1351            */
1352            @Deprecated
1353            public static long importLayoutsInBackground(long userId,
1354                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1355                    java.io.File file)
1356                    throws com.liferay.portal.kernel.exception.PortalException {
1357                    return getService()
1358                                       .importLayoutsInBackground(userId,
1359                            exportImportConfiguration, file);
1360            }
1361    
1362            /**
1363            * @throws PortalException
1364            * @deprecated As of 7.0.0, replaced by {@link
1365            com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayoutsInBackground(
1366            long, long, File)}
1367            */
1368            @Deprecated
1369            public static long importLayoutsInBackground(long userId,
1370                    long exportImportConfigurationId, java.io.File file)
1371                    throws com.liferay.portal.kernel.exception.PortalException {
1372                    return getService()
1373                                       .importLayoutsInBackground(userId,
1374                            exportImportConfigurationId, file);
1375            }
1376    
1377            /**
1378            * @throws PortalException
1379            * @deprecated As of 7.0.0, with no direct replacement
1380            */
1381            @Deprecated
1382            public static long importLayoutsInBackground(long userId,
1383                    java.lang.String taskName, long groupId, boolean privateLayout,
1384                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1385                    java.io.File file)
1386                    throws com.liferay.portal.kernel.exception.PortalException {
1387                    return getService()
1388                                       .importLayoutsInBackground(userId, taskName, groupId,
1389                            privateLayout, parameterMap, file);
1390            }
1391    
1392            /**
1393            * @throws PortalException
1394            * @deprecated As of 7.0.0, with no direct replacement
1395            */
1396            @Deprecated
1397            public static long importLayoutsInBackground(long userId,
1398                    java.lang.String taskName, long groupId, boolean privateLayout,
1399                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1400                    java.io.InputStream is)
1401                    throws com.liferay.portal.kernel.exception.PortalException {
1402                    return getService()
1403                                       .importLayoutsInBackground(userId, taskName, groupId,
1404                            privateLayout, parameterMap, is);
1405            }
1406    
1407            /**
1408            * @throws PortalException
1409            * @deprecated As of 7.0.0, replaced by {@link
1410            com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletDataDeletions(
1411            ExportImportConfiguration, File)}
1412            */
1413            @Deprecated
1414            public static void importPortletDataDeletions(
1415                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1416                    java.io.File file)
1417                    throws com.liferay.portal.kernel.exception.PortalException {
1418                    getService().importPortletDataDeletions(exportImportConfiguration, file);
1419            }
1420    
1421            /**
1422            * @throws PortalException
1423            * @deprecated As of 7.0.0, replaced by {@link
1424            com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfo(
1425            ExportImportConfiguration, File)}
1426            */
1427            @Deprecated
1428            public static void importPortletInfo(
1429                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1430                    java.io.File file)
1431                    throws com.liferay.portal.kernel.exception.PortalException {
1432                    getService().importPortletInfo(exportImportConfiguration, file);
1433            }
1434    
1435            /**
1436            * @throws PortalException
1437            * @deprecated As of 7.0.0, replaced by {@link
1438            com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfo(
1439            ExportImportConfiguration, InputStream)}
1440            */
1441            @Deprecated
1442            public static void importPortletInfo(
1443                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1444                    java.io.InputStream is)
1445                    throws com.liferay.portal.kernel.exception.PortalException {
1446                    getService().importPortletInfo(exportImportConfiguration, is);
1447            }
1448    
1449            /**
1450            * Imports the portlet information (categories, permissions, ... etc.) from
1451            * the file.
1452            *
1453            * @param userId the primary key of the user
1454            * @param plid the primary key of the target layout
1455            * @param groupId the primary key of the target group
1456            * @param portletId the primary key of the portlet
1457            * @param parameterMap the mapping of parameters indicating which
1458            information will be imported. For information on the keys
1459            used in the map see {@link
1460            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
1461            * @param file the LAR file with the data
1462            * @throws PortalException
1463            * @deprecated As of 7.0.0, with no direct replacement
1464            */
1465            @Deprecated
1466            public static void importPortletInfo(long userId, long plid, long groupId,
1467                    java.lang.String portletId,
1468                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1469                    java.io.File file)
1470                    throws com.liferay.portal.kernel.exception.PortalException {
1471                    getService()
1472                            .importPortletInfo(userId, plid, groupId, portletId, parameterMap,
1473                            file);
1474            }
1475    
1476            /**
1477            * Imports the portlet information (categories, permissions, ... etc.) from
1478            * the input stream.
1479            *
1480            * @param userId the primary key of the user
1481            * @param plid the primary key of the layout
1482            * @param groupId the primary key of the group
1483            * @param portletId the primary key of the portlet
1484            * @param parameterMap the mapping of parameters indicating which
1485            information will be imported. For information on the keys
1486            used in the map see {@link
1487            com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}.
1488            * @param is the input stream
1489            * @throws PortalException
1490            * @deprecated As of 7.0.0, with no direct replacement
1491            */
1492            @Deprecated
1493            public static void importPortletInfo(long userId, long plid, long groupId,
1494                    java.lang.String portletId,
1495                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1496                    java.io.InputStream is)
1497                    throws com.liferay.portal.kernel.exception.PortalException {
1498                    getService()
1499                            .importPortletInfo(userId, plid, groupId, portletId, parameterMap,
1500                            is);
1501            }
1502    
1503            /**
1504            * @throws PortalException
1505            * @deprecated As of 7.0.0, with no direct replacement
1506            */
1507            @Deprecated
1508            public static void importPortletInfo(long userId,
1509                    java.lang.String portletId,
1510                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1511                    java.io.File file)
1512                    throws com.liferay.portal.kernel.exception.PortalException {
1513                    getService().importPortletInfo(userId, portletId, parameterMap, file);
1514            }
1515    
1516            /**
1517            * @throws PortalException
1518            * @deprecated As of 7.0.0, with no direct replacement
1519            */
1520            @Deprecated
1521            public static void importPortletInfo(long userId,
1522                    java.lang.String portletId,
1523                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1524                    java.io.InputStream is)
1525                    throws com.liferay.portal.kernel.exception.PortalException {
1526                    getService().importPortletInfo(userId, portletId, parameterMap, is);
1527            }
1528    
1529            /**
1530            * @throws PortalException
1531            * @deprecated As of 7.0.0, replaced by {@link
1532            com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfoInBackground(
1533            long, ExportImportConfiguration, File)}
1534            */
1535            @Deprecated
1536            public static long importPortletInfoInBackground(long userId,
1537                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
1538                    java.io.File file)
1539                    throws com.liferay.portal.kernel.exception.PortalException {
1540                    return getService()
1541                                       .importPortletInfoInBackground(userId,
1542                            exportImportConfiguration, file);
1543            }
1544    
1545            /**
1546            * @throws PortalException
1547            * @deprecated As of 7.0.0, replaced by {@link
1548            com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfoInBackground(
1549            long, long, File)}
1550            */
1551            @Deprecated
1552            public static long importPortletInfoInBackground(long userId,
1553                    long exportImportConfigurationId, java.io.File file)
1554                    throws com.liferay.portal.kernel.exception.PortalException {
1555                    return getService()
1556                                       .importPortletInfoInBackground(userId,
1557                            exportImportConfigurationId, file);
1558            }
1559    
1560            /**
1561            * @throws PortalException
1562            * @deprecated As of 7.0.0, with no direct replacement
1563            */
1564            @Deprecated
1565            public static long importPortletInfoInBackground(long userId,
1566                    java.lang.String taskName, long plid, long groupId,
1567                    java.lang.String portletId,
1568                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1569                    java.io.File file)
1570                    throws com.liferay.portal.kernel.exception.PortalException {
1571                    return getService()
1572                                       .importPortletInfoInBackground(userId, taskName, plid,
1573                            groupId, portletId, parameterMap, file);
1574            }
1575    
1576            /**
1577            * @throws PortalException
1578            * @deprecated As of 7.0.0, with no direct replacement
1579            */
1580            @Deprecated
1581            public static long importPortletInfoInBackground(long userId,
1582                    java.lang.String taskName, long plid, long groupId,
1583                    java.lang.String portletId,
1584                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1585                    java.io.InputStream is)
1586                    throws com.liferay.portal.kernel.exception.PortalException {
1587                    return getService()
1588                                       .importPortletInfoInBackground(userId, taskName, plid,
1589                            groupId, portletId, parameterMap, is);
1590            }
1591    
1592            /**
1593            * @throws PortalException
1594            * @deprecated As of 7.0.0, with no direct replacement
1595            */
1596            @Deprecated
1597            public static long importPortletInfoInBackground(long userId,
1598                    java.lang.String taskName, java.lang.String portletId,
1599                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1600                    java.io.File file)
1601                    throws com.liferay.portal.kernel.exception.PortalException {
1602                    return getService()
1603                                       .importPortletInfoInBackground(userId, taskName, portletId,
1604                            parameterMap, file);
1605            }
1606    
1607            /**
1608            * @throws PortalException
1609            * @deprecated As of 7.0.0, with no direct replacement
1610            */
1611            @Deprecated
1612            public static long importPortletInfoInBackground(long userId,
1613                    java.lang.String taskName, java.lang.String portletId,
1614                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
1615                    java.io.InputStream is)
1616                    throws com.liferay.portal.kernel.exception.PortalException {
1617                    return getService()
1618                                       .importPortletInfoInBackground(userId, taskName, portletId,
1619                            parameterMap, is);
1620            }
1621    
1622            /**
1623            * Sets the layouts for the group, replacing and prioritizing all layouts of
1624            * the parent layout.
1625            *
1626            * @param groupId the primary key of the group
1627            * @param privateLayout whether the layout is private to the group
1628            * @param parentLayoutId the primary key of the parent layout
1629            * @param layoutIds the primary keys of the layouts
1630            * @param serviceContext the service context to be applied
1631            */
1632            public static void setLayouts(long groupId, boolean privateLayout,
1633                    long parentLayoutId, long[] layoutIds,
1634                    com.liferay.portal.service.ServiceContext serviceContext)
1635                    throws com.liferay.portal.kernel.exception.PortalException {
1636                    getService()
1637                            .setLayouts(groupId, privateLayout, parentLayoutId, layoutIds,
1638                            serviceContext);
1639            }
1640    
1641            public static void updateAsset(long userId,
1642                    com.liferay.portal.model.Layout layout, long[] assetCategoryIds,
1643                    java.lang.String[] assetTagNames)
1644                    throws com.liferay.portal.kernel.exception.PortalException {
1645                    getService().updateAsset(userId, layout, assetCategoryIds, assetTagNames);
1646            }
1647    
1648            /**
1649            * Updates the friendly URL of the layout.
1650            *
1651            * @param plid the primary key of the layout
1652            * @param friendlyURL the friendly URL to be assigned
1653            * @param languageId the primary key of the language
1654            * @return the updated layout
1655            * @deprecated As of 7.0.0, replaced by {@link #updateFriendlyURL(long,
1656            long, String, String)}
1657            */
1658            @Deprecated
1659            public static com.liferay.portal.model.Layout updateFriendlyURL(long plid,
1660                    java.lang.String friendlyURL, java.lang.String languageId)
1661                    throws com.liferay.portal.kernel.exception.PortalException {
1662                    return getService().updateFriendlyURL(plid, friendlyURL, languageId);
1663            }
1664    
1665            /**
1666            * Updates the friendly URL of the layout.
1667            *
1668            * @param userId the primary key of the user
1669            * @param plid the primary key of the layout
1670            * @param friendlyURL the friendly URL to be assigned
1671            * @param languageId the primary key of the language
1672            * @return the updated layout
1673            */
1674            public static com.liferay.portal.model.Layout updateFriendlyURL(
1675                    long userId, long plid, java.lang.String friendlyURL,
1676                    java.lang.String languageId)
1677                    throws com.liferay.portal.kernel.exception.PortalException {
1678                    return getService()
1679                                       .updateFriendlyURL(userId, plid, friendlyURL, languageId);
1680            }
1681    
1682            public static com.liferay.portal.model.Layout updateIconImage(long plid,
1683                    byte[] bytes)
1684                    throws com.liferay.portal.kernel.exception.PortalException {
1685                    return getService().updateIconImage(plid, bytes);
1686            }
1687    
1688            /**
1689            * Updates the layout.
1690            *
1691            * @param groupId the primary key of the group
1692            * @param privateLayout whether the layout is private to the group
1693            * @param layoutId the primary key of the layout
1694            * @param parentLayoutId the primary key of the layout's new parent
1695            layout
1696            * @param nameMap the locales and localized names to merge (optionally
1697            <code>null</code>)
1698            * @param titleMap the locales and localized titles to merge
1699            (optionally <code>null</code>)
1700            * @param descriptionMap the locales and localized descriptions to
1701            merge (optionally <code>null</code>)
1702            * @param keywordsMap the locales and localized keywords to merge
1703            (optionally <code>null</code>)
1704            * @param robotsMap the locales and localized robots to merge
1705            (optionally <code>null</code>)
1706            * @param type the layout's new type (optionally {@link
1707            LayoutConstants#TYPE_PORTLET})
1708            * @param hidden whether the layout is hidden
1709            * @param friendlyURL the layout's new friendly URL (optionally {@link
1710            PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} or
1711            {@link
1712            PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}). The
1713            default values can be overridden in
1714            <code>portal-ext.properties</code> by specifying new values
1715            for the corresponding properties defined in {@link
1716            PropsValues}. To see how the URL is normalized when accessed,
1717            see {@link
1718            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
1719            String)}.
1720            * @param iconImage whether the icon image will be updated
1721            * @param iconBytes the byte array of the layout's new icon image
1722            * @param serviceContext the service context to be applied. Can set the
1723            modification date and expando bridge attributes for the
1724            layout. For layouts that are linked to a layout prototype,
1725            attributes named <code>layoutPrototypeUuid</code> and
1726            <code>layoutPrototypeLinkedEnabled</code> can be specified to
1727            provide the unique identifier of the source prototype and a
1728            boolean to determine whether a link to it should be enabled
1729            to activate propagation of changes made to the linked page in
1730            the prototype.
1731            * @return the updated layout
1732            * @deprecated As of 6.2.0, replaced by {@link #updateLayout(long, boolean,
1733            long, long, Map, Map, Map, Map, Map, String, boolean, Map,
1734            boolean, byte[], ServiceContext)}
1735            */
1736            @Deprecated
1737            public static com.liferay.portal.model.Layout updateLayout(long groupId,
1738                    boolean privateLayout, long layoutId, long parentLayoutId,
1739                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
1740                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
1741                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
1742                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
1743                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
1744                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
1745                    java.lang.Boolean iconImage, byte[] iconBytes,
1746                    com.liferay.portal.service.ServiceContext serviceContext)
1747                    throws com.liferay.portal.kernel.exception.PortalException {
1748                    return getService()
1749                                       .updateLayout(groupId, privateLayout, layoutId,
1750                            parentLayoutId, nameMap, titleMap, descriptionMap, keywordsMap,
1751                            robotsMap, type, hidden, friendlyURL, iconImage, iconBytes,
1752                            serviceContext);
1753            }
1754    
1755            /**
1756            * Updates the layout.
1757            *
1758            * @param groupId the primary key of the group
1759            * @param privateLayout whether the layout is private to the group
1760            * @param layoutId the primary key of the layout
1761            * @param parentLayoutId the primary key of the layout's new parent layout
1762            * @param nameMap the locales and localized names to merge (optionally
1763            <code>null</code>)
1764            * @param titleMap the locales and localized titles to merge (optionally
1765            <code>null</code>)
1766            * @param descriptionMap the locales and localized descriptions to merge
1767            (optionally <code>null</code>)
1768            * @param keywordsMap the locales and localized keywords to merge
1769            (optionally <code>null</code>)
1770            * @param robotsMap the locales and localized robots to merge (optionally
1771            <code>null</code>)
1772            * @param type the layout's new type (optionally {@link
1773            LayoutConstants#TYPE_PORTLET})
1774            * @param hidden whether the layout is hidden
1775            * @param friendlyURLMap the layout's locales and localized friendly URLs.
1776            To see how the URL is normalized when accessed, see {@link
1777            com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize(
1778            String)}.
1779            * @param iconImage whether the icon image will be updated
1780            * @param iconBytes the byte array of the layout's new icon image
1781            * @param serviceContext the service context to be applied. Can set the
1782            modification date and expando bridge attributes for the layout.
1783            For layouts that are linked to a layout prototype, attributes
1784            named <code>layoutPrototypeUuid</code> and
1785            <code>layoutPrototypeLinkedEnabled</code> can be specified to
1786            provide the unique identifier of the source prototype and a
1787            boolean to determine whether a link to it should be enabled to
1788            activate propagation of changes made to the linked page in the
1789            prototype.
1790            * @return the updated layout
1791            */
1792            public static com.liferay.portal.model.Layout updateLayout(long groupId,
1793                    boolean privateLayout, long layoutId, long parentLayoutId,
1794                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
1795                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
1796                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
1797                    java.util.Map<java.util.Locale, java.lang.String> keywordsMap,
1798                    java.util.Map<java.util.Locale, java.lang.String> robotsMap,
1799                    java.lang.String type, boolean hidden,
1800                    java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap,
1801                    boolean iconImage, byte[] iconBytes,
1802                    com.liferay.portal.service.ServiceContext serviceContext)
1803                    throws com.liferay.portal.kernel.exception.PortalException {
1804                    return getService()
1805                                       .updateLayout(groupId, privateLayout, layoutId,
1806                            parentLayoutId, nameMap, titleMap, descriptionMap, keywordsMap,
1807                            robotsMap, type, hidden, friendlyURLMap, iconImage, iconBytes,
1808                            serviceContext);
1809            }
1810    
1811            /**
1812            * Updates the layout replacing its type settings.
1813            *
1814            * @param groupId the primary key of the group
1815            * @param privateLayout whether the layout is private to the group
1816            * @param layoutId the primary key of the layout
1817            * @param typeSettings the settings to load the unicode properties object.
1818            See {@link UnicodeProperties #fastLoad(String)}.
1819            * @return the updated layout
1820            */
1821            public static com.liferay.portal.model.Layout updateLayout(long groupId,
1822                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
1823                    throws com.liferay.portal.kernel.exception.PortalException {
1824                    return getService()
1825                                       .updateLayout(groupId, privateLayout, layoutId, typeSettings);
1826            }
1827    
1828            /**
1829            * Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
1830            *
1831            * @param layout the layout
1832            * @return the layout that was updated
1833            */
1834            public static com.liferay.portal.model.Layout updateLayout(
1835                    com.liferay.portal.model.Layout layout) {
1836                    return getService().updateLayout(layout);
1837            }
1838    
1839            /**
1840            * Updates the look and feel of the layout.
1841            *
1842            * @param groupId the primary key of the group
1843            * @param privateLayout whether the layout is private to the group
1844            * @param layoutId the primary key of the layout
1845            * @param themeId the primary key of the layout's new theme
1846            * @param colorSchemeId the primary key of the layout's new color scheme
1847            * @param css the layout's new CSS
1848            * @param wapTheme whether the theme is for WAP browsers
1849            * @return the updated layout
1850            */
1851            public static com.liferay.portal.model.Layout updateLookAndFeel(
1852                    long groupId, boolean privateLayout, long layoutId,
1853                    java.lang.String themeId, java.lang.String colorSchemeId,
1854                    java.lang.String css, boolean wapTheme)
1855                    throws com.liferay.portal.kernel.exception.PortalException {
1856                    return getService()
1857                                       .updateLookAndFeel(groupId, privateLayout, layoutId,
1858                            themeId, colorSchemeId, css, wapTheme);
1859            }
1860    
1861            /**
1862            * Updates the name of the layout matching the group, layout ID, and
1863            * privacy.
1864            *
1865            * @param groupId the primary key of the group
1866            * @param privateLayout whether the layout is private to the group
1867            * @param layoutId the primary key of the layout
1868            * @param name the layout's new name
1869            * @param languageId the primary key of the language. For more information
1870            see {@link Locale}.
1871            * @return the updated layout
1872            */
1873            public static com.liferay.portal.model.Layout updateName(long groupId,
1874                    boolean privateLayout, long layoutId, java.lang.String name,
1875                    java.lang.String languageId)
1876                    throws com.liferay.portal.kernel.exception.PortalException {
1877                    return getService()
1878                                       .updateName(groupId, privateLayout, layoutId, name,
1879                            languageId);
1880            }
1881    
1882            /**
1883            * Updates the name of the layout.
1884            *
1885            * @param layout the layout to be updated
1886            * @param name the layout's new name
1887            * @param languageId the primary key of the language. For more information
1888            see {@link Locale}.
1889            * @return the updated layout
1890            */
1891            public static com.liferay.portal.model.Layout updateName(
1892                    com.liferay.portal.model.Layout layout, java.lang.String name,
1893                    java.lang.String languageId)
1894                    throws com.liferay.portal.kernel.exception.PortalException {
1895                    return getService().updateName(layout, name, languageId);
1896            }
1897    
1898            /**
1899            * Updates the name of the layout matching the primary key.
1900            *
1901            * @param plid the primary key of the layout
1902            * @param name the name to be assigned
1903            * @param languageId the primary key of the language. For more information
1904            see {@link Locale}.
1905            * @return the updated layout
1906            */
1907            public static com.liferay.portal.model.Layout updateName(long plid,
1908                    java.lang.String name, java.lang.String languageId)
1909                    throws com.liferay.portal.kernel.exception.PortalException {
1910                    return getService().updateName(plid, name, languageId);
1911            }
1912    
1913            /**
1914            * Updates the parent layout ID of the layout matching the group, layout ID,
1915            * and privacy.
1916            *
1917            * @param groupId the primary key of the group
1918            * @param privateLayout whether the layout is private to the group
1919            * @param layoutId the primary key of the layout
1920            * @param parentLayoutId the primary key to be assigned to the parent
1921            layout
1922            * @return the matching layout
1923            */
1924            public static com.liferay.portal.model.Layout updateParentLayoutId(
1925                    long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
1926                    throws com.liferay.portal.kernel.exception.PortalException {
1927                    return getService()
1928                                       .updateParentLayoutId(groupId, privateLayout, layoutId,
1929                            parentLayoutId);
1930            }
1931    
1932            /**
1933            * Updates the parent layout ID of the layout matching the primary key. If a
1934            * layout matching the parent primary key is found, the layout ID of that
1935            * layout is assigned, otherwise {@link
1936            * LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is assigned.
1937            *
1938            * @param plid the primary key of the layout
1939            * @param parentPlid the primary key of the parent layout
1940            * @return the layout matching the primary key
1941            */
1942            public static com.liferay.portal.model.Layout updateParentLayoutId(
1943                    long plid, long parentPlid)
1944                    throws com.liferay.portal.kernel.exception.PortalException {
1945                    return getService().updateParentLayoutId(plid, parentPlid);
1946            }
1947    
1948            /**
1949            * Updates the parent layout ID and priority of the layout.
1950            *
1951            * @param plid the primary key of the layout
1952            * @param parentPlid the primary key of the parent layout
1953            * @param priority the layout's new priority
1954            * @return the layout matching the primary key
1955            */
1956            public static com.liferay.portal.model.Layout updateParentLayoutIdAndPriority(
1957                    long plid, long parentPlid, int priority)
1958                    throws com.liferay.portal.kernel.exception.PortalException {
1959                    return getService()
1960                                       .updateParentLayoutIdAndPriority(plid, parentPlid, priority);
1961            }
1962    
1963            /**
1964            * Updates the priorities of the layouts.
1965            *
1966            * @param groupId the primary key of the group
1967            * @param privateLayout whether the layout is private to the group
1968            * @throws PortalException
1969            */
1970            public static void updatePriorities(long groupId, boolean privateLayout)
1971                    throws com.liferay.portal.kernel.exception.PortalException {
1972                    getService().updatePriorities(groupId, privateLayout);
1973            }
1974    
1975            /**
1976            * Updates the priority of the layout matching the group, layout ID, and
1977            * privacy, setting the layout's priority based on the priorities of the
1978            * next and previous layouts.
1979            *
1980            * @param groupId the primary key of the group
1981            * @param privateLayout whether the layout is private to the group
1982            * @param layoutId the primary key of the layout
1983            * @param nextLayoutId the primary key of the next layout
1984            * @param previousLayoutId the primary key of the previous layout
1985            * @return the updated layout
1986            */
1987            public static com.liferay.portal.model.Layout updatePriority(long groupId,
1988                    boolean privateLayout, long layoutId, long nextLayoutId,
1989                    long previousLayoutId)
1990                    throws com.liferay.portal.kernel.exception.PortalException {
1991                    return getService()
1992                                       .updatePriority(groupId, privateLayout, layoutId,
1993                            nextLayoutId, previousLayoutId);
1994            }
1995    
1996            /**
1997            * Updates the priority of the layout matching the group, layout ID, and
1998            * privacy.
1999            *
2000            * @param groupId the primary key of the group
2001            * @param privateLayout whether the layout is private to the group
2002            * @param layoutId the primary key of the layout
2003            * @param priority the layout's new priority
2004            * @return the updated layout
2005            */
2006            public static com.liferay.portal.model.Layout updatePriority(long groupId,
2007                    boolean privateLayout, long layoutId, int priority)
2008                    throws com.liferay.portal.kernel.exception.PortalException {
2009                    return getService()
2010                                       .updatePriority(groupId, privateLayout, layoutId, priority);
2011            }
2012    
2013            /**
2014            * Updates the priority of the layout.
2015            *
2016            * @param layout the layout to be updated
2017            * @param priority the layout's new priority
2018            * @return the updated layout
2019            */
2020            public static com.liferay.portal.model.Layout updatePriority(
2021                    com.liferay.portal.model.Layout layout, int priority)
2022                    throws com.liferay.portal.kernel.exception.PortalException {
2023                    return getService().updatePriority(layout, priority);
2024            }
2025    
2026            /**
2027            * Updates the priority of the layout matching the primary key.
2028            *
2029            * @param plid the primary key of the layout
2030            * @param priority the layout's new priority
2031            * @return the updated layout
2032            */
2033            public static com.liferay.portal.model.Layout updatePriority(long plid,
2034                    int priority)
2035                    throws com.liferay.portal.kernel.exception.PortalException {
2036                    return getService().updatePriority(plid, priority);
2037            }
2038    
2039            /**
2040            * Updates the names of the portlets within scope of the group, the scope of
2041            * the layout's UUID, and the privacy.
2042            *
2043            * @param groupId the primary key of the group
2044            * @param privateLayout whether the layout is private to the group
2045            * @param layoutId the primary key of the layout whose UUID to match
2046            * @param name the new name for the portlets
2047            * @param languageId the primary key of the language
2048            * @throws PortalException
2049            * @see com.liferay.portlet.portletconfiguration.action.EditScopeAction
2050            * @deprecated As of 6.2.0, with no direct replacement
2051            */
2052            @Deprecated
2053            public static void updateScopedPortletNames(long groupId,
2054                    boolean privateLayout, long layoutId, java.lang.String name,
2055                    java.lang.String languageId)
2056                    throws com.liferay.portal.kernel.exception.PortalException {
2057                    getService()
2058                            .updateScopedPortletNames(groupId, privateLayout, layoutId, name,
2059                            languageId);
2060            }
2061    
2062            /**
2063            * @deprecated As of 6.2.0, with no direct replacement
2064            */
2065            @Deprecated
2066            public static void updateScopedPortletNames(long groupId,
2067                    boolean privateLayout, long layoutId,
2068                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
2069                    java.util.List<java.util.Locale> nameMapModifiedLocales)
2070                    throws com.liferay.portal.kernel.exception.PortalException {
2071                    getService()
2072                            .updateScopedPortletNames(groupId, privateLayout, layoutId,
2073                            nameMap, nameMapModifiedLocales);
2074            }
2075    
2076            /**
2077            * @throws PortalException
2078            * @deprecated As of 7.0.0, replaced by {@link
2079            com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportLayoutsFile(
2080            ExportImportConfiguration, File)}
2081            */
2082            @Deprecated
2083            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile(
2084                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
2085                    java.io.File file)
2086                    throws com.liferay.portal.kernel.exception.PortalException {
2087                    return getService()
2088                                       .validateImportLayoutsFile(exportImportConfiguration, file);
2089            }
2090    
2091            /**
2092            * @throws PortalException
2093            * @deprecated As of 7.0.0, replaced by {@link
2094            com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportLayoutsFile(
2095            ExportImportConfiguration, InputStream)}
2096            */
2097            @Deprecated
2098            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile(
2099                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
2100                    java.io.InputStream inputStream)
2101                    throws com.liferay.portal.kernel.exception.PortalException {
2102                    return getService()
2103                                       .validateImportLayoutsFile(exportImportConfiguration,
2104                            inputStream);
2105            }
2106    
2107            /**
2108            * @throws PortalException
2109            * @deprecated As of 7.0.0, with no direct replacement
2110            */
2111            @Deprecated
2112            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile(
2113                    long userId, long groupId, boolean privateLayout,
2114                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
2115                    java.io.File file)
2116                    throws com.liferay.portal.kernel.exception.PortalException {
2117                    return getService()
2118                                       .validateImportLayoutsFile(userId, groupId, privateLayout,
2119                            parameterMap, file);
2120            }
2121    
2122            /**
2123            * @throws PortalException
2124            * @deprecated As of 7.0.0, with no direct replacement
2125            */
2126            @Deprecated
2127            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile(
2128                    long userId, long groupId, boolean privateLayout,
2129                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
2130                    java.io.InputStream inputStream)
2131                    throws com.liferay.portal.kernel.exception.PortalException {
2132                    return getService()
2133                                       .validateImportLayoutsFile(userId, groupId, privateLayout,
2134                            parameterMap, inputStream);
2135            }
2136    
2137            /**
2138            * @throws PortalException
2139            * @deprecated As of 7.0.0, replaced by {@link
2140            com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportPortletInfo(
2141            ExportImportConfiguration, File)}
2142            */
2143            @Deprecated
2144            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo(
2145                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
2146                    java.io.File file)
2147                    throws com.liferay.portal.kernel.exception.PortalException {
2148                    return getService()
2149                                       .validateImportPortletInfo(exportImportConfiguration, file);
2150            }
2151    
2152            /**
2153            * @throws PortalException
2154            * @deprecated As of 7.0.0, replaced by {@link
2155            com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportPortletInfo(
2156            ExportImportConfiguration, InputStream)}
2157            */
2158            @Deprecated
2159            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo(
2160                    com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration,
2161                    java.io.InputStream inputStream)
2162                    throws com.liferay.portal.kernel.exception.PortalException {
2163                    return getService()
2164                                       .validateImportPortletInfo(exportImportConfiguration,
2165                            inputStream);
2166            }
2167    
2168            /**
2169            * @throws PortalException
2170            * @deprecated As of 7.0.0, with no direct replacement
2171            */
2172            @Deprecated
2173            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo(
2174                    long userId, long plid, long groupId, java.lang.String portletId,
2175                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
2176                    java.io.File file)
2177                    throws com.liferay.portal.kernel.exception.PortalException {
2178                    return getService()
2179                                       .validateImportPortletInfo(userId, plid, groupId, portletId,
2180                            parameterMap, file);
2181            }
2182    
2183            /**
2184            * @throws PortalException
2185            * @deprecated As of 7.0.0, with no direct replacement
2186            */
2187            @Deprecated
2188            public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo(
2189                    long userId, long plid, long groupId, java.lang.String portletId,
2190                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
2191                    java.io.InputStream inputStream)
2192                    throws com.liferay.portal.kernel.exception.PortalException {
2193                    return getService()
2194                                       .validateImportPortletInfo(userId, plid, groupId, portletId,
2195                            parameterMap, inputStream);
2196            }
2197    
2198            public static LayoutLocalService getService() {
2199                    if (_service == null) {
2200                            _service = (LayoutLocalService)PortalBeanLocatorUtil.locate(LayoutLocalService.class.getName());
2201    
2202                            ReferenceRegistry.registerReference(LayoutLocalServiceUtil.class,
2203                                    "_service");
2204                    }
2205    
2206                    return _service;
2207            }
2208    
2209            private static LayoutLocalService _service;
2210    }