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