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