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