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