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 java.lang.String[] getTempFileEntryNames(long groupId, 636 java.lang.String tempFolderName) 637 throws com.liferay.portal.kernel.exception.PortalException, 638 com.liferay.portal.kernel.exception.SystemException { 639 return _layoutService.getTempFileEntryNames(groupId, tempFolderName); 640 } 641 642 /** 643 * Imports the layouts from the byte array. 644 * 645 * @param groupId the primary key of the group 646 * @param privateLayout whether the layout is private to the group 647 * @param parameterMap the mapping of parameters indicating which 648 information will be imported. For information on the keys used in 649 the map see {@link 650 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 651 * @param bytes the byte array with the data 652 * @throws PortalException if a group with the primary key could not be 653 found, if the group did not have permission to manage the 654 layouts, or if some other portal exception occurred 655 * @throws SystemException if a system exception occurred 656 * @see com.liferay.portal.lar.LayoutImporter 657 */ 658 @Override 659 public void importLayouts(long groupId, boolean privateLayout, 660 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 661 byte[] bytes) 662 throws com.liferay.portal.kernel.exception.PortalException, 663 com.liferay.portal.kernel.exception.SystemException { 664 _layoutService.importLayouts(groupId, privateLayout, parameterMap, bytes); 665 } 666 667 /** 668 * Imports the layouts from the file. 669 * 670 * @param groupId the primary key of the group 671 * @param privateLayout whether the layout is private to the group 672 * @param parameterMap the mapping of parameters indicating which 673 information will be imported. For information on the keys used in 674 the map see {@link 675 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 676 * @param file the LAR file with the data 677 * @throws PortalException if a group with the primary key could not be 678 found, if the group did not have permission to manage the layouts 679 and publish, or if some other portal exception occurred 680 * @throws SystemException if a system exception occurred 681 * @see com.liferay.portal.lar.LayoutImporter 682 */ 683 @Override 684 public void importLayouts(long groupId, boolean privateLayout, 685 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 686 java.io.File file) 687 throws com.liferay.portal.kernel.exception.PortalException, 688 com.liferay.portal.kernel.exception.SystemException { 689 _layoutService.importLayouts(groupId, privateLayout, parameterMap, file); 690 } 691 692 /** 693 * Imports the layouts from the input stream. 694 * 695 * @param groupId the primary key of the group 696 * @param privateLayout whether the layout is private to the group 697 * @param parameterMap the mapping of parameters indicating which 698 information will be imported. For information on the keys used in 699 the map see {@link 700 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 701 * @param is the input stream 702 * @throws PortalException if a group with the primary key could not be 703 found, if the group did not have permission to manage the 704 layouts, or if some other portal exception occurred 705 * @throws SystemException if a system exception occurred 706 * @see com.liferay.portal.lar.LayoutImporter 707 */ 708 @Override 709 public void importLayouts(long groupId, boolean privateLayout, 710 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 711 java.io.InputStream is) 712 throws com.liferay.portal.kernel.exception.PortalException, 713 com.liferay.portal.kernel.exception.SystemException { 714 _layoutService.importLayouts(groupId, privateLayout, parameterMap, is); 715 } 716 717 @Override 718 public long importLayoutsInBackground(java.lang.String taskName, 719 long groupId, boolean privateLayout, 720 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 721 java.io.File file) 722 throws com.liferay.portal.kernel.exception.PortalException, 723 com.liferay.portal.kernel.exception.SystemException { 724 return _layoutService.importLayoutsInBackground(taskName, groupId, 725 privateLayout, parameterMap, file); 726 } 727 728 @Override 729 public long importLayoutsInBackground(java.lang.String taskName, 730 long groupId, boolean privateLayout, 731 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 732 java.io.InputStream inputStream) 733 throws com.liferay.portal.kernel.exception.PortalException, 734 com.liferay.portal.kernel.exception.SystemException { 735 return _layoutService.importLayoutsInBackground(taskName, groupId, 736 privateLayout, parameterMap, inputStream); 737 } 738 739 /** 740 * Imports the portlet information (categories, permissions, ... etc.) from 741 * the file. 742 * 743 * @param plid the primary key of the layout 744 * @param groupId the primary key of the group 745 * @param portletId the primary key of the portlet 746 * @param parameterMap the mapping of parameters indicating which 747 information will be imported. For information on the keys used in 748 the map see {@link 749 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 750 * @param file the LAR file with the data 751 * @throws PortalException if a group, layout, or portlet with the primary 752 key could not be found, or if the group did not have permission 753 to manage the layouts 754 * @throws SystemException if a system exception occurred 755 */ 756 @Override 757 public void importPortletInfo(long plid, long groupId, 758 java.lang.String portletId, 759 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 760 java.io.File file) 761 throws com.liferay.portal.kernel.exception.PortalException, 762 com.liferay.portal.kernel.exception.SystemException { 763 _layoutService.importPortletInfo(plid, groupId, portletId, 764 parameterMap, file); 765 } 766 767 /** 768 * Imports the portlet information (categories, permissions, ... etc.) from 769 * the input stream. 770 * 771 * @param plid the primary key of the layout 772 * @param groupId the primary key of the group 773 * @param portletId the primary key of the portlet 774 * @param parameterMap the mapping of parameters indicating which 775 information will be imported. For information on the keys used in 776 the map see {@link 777 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 778 * @param is the input stream 779 * @throws PortalException if a group, portlet, or layout with the primary 780 key could not be found or if the group did not have permission to 781 manage the layouts 782 * @throws SystemException if a system exception occurred 783 */ 784 @Override 785 public void importPortletInfo(long plid, long groupId, 786 java.lang.String portletId, 787 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 788 java.io.InputStream is) 789 throws com.liferay.portal.kernel.exception.PortalException, 790 com.liferay.portal.kernel.exception.SystemException { 791 _layoutService.importPortletInfo(plid, groupId, portletId, 792 parameterMap, is); 793 } 794 795 @Override 796 public void importPortletInfo(java.lang.String portletId, 797 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 798 java.io.File file) 799 throws com.liferay.portal.kernel.exception.PortalException, 800 com.liferay.portal.kernel.exception.SystemException { 801 _layoutService.importPortletInfo(portletId, parameterMap, file); 802 } 803 804 @Override 805 public void importPortletInfo(java.lang.String portletId, 806 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 807 java.io.InputStream is) 808 throws com.liferay.portal.kernel.exception.PortalException, 809 com.liferay.portal.kernel.exception.SystemException { 810 _layoutService.importPortletInfo(portletId, parameterMap, is); 811 } 812 813 @Override 814 public long importPortletInfoInBackground(java.lang.String taskName, 815 long plid, long groupId, java.lang.String portletId, 816 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 817 java.io.File file) 818 throws com.liferay.portal.kernel.exception.PortalException, 819 com.liferay.portal.kernel.exception.SystemException { 820 return _layoutService.importPortletInfoInBackground(taskName, plid, 821 groupId, portletId, parameterMap, file); 822 } 823 824 @Override 825 public long importPortletInfoInBackground(java.lang.String taskName, 826 long plid, long groupId, java.lang.String portletId, 827 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 828 java.io.InputStream is) 829 throws com.liferay.portal.kernel.exception.PortalException, 830 com.liferay.portal.kernel.exception.SystemException { 831 return _layoutService.importPortletInfoInBackground(taskName, plid, 832 groupId, portletId, parameterMap, is); 833 } 834 835 @Override 836 public void importPortletInfoInBackground(java.lang.String taskName, 837 java.lang.String portletId, 838 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 839 java.io.File file) 840 throws com.liferay.portal.kernel.exception.PortalException, 841 com.liferay.portal.kernel.exception.SystemException { 842 _layoutService.importPortletInfoInBackground(taskName, portletId, 843 parameterMap, file); 844 } 845 846 @Override 847 public void importPortletInfoInBackground(java.lang.String taskName, 848 java.lang.String portletId, 849 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 850 java.io.InputStream is) 851 throws com.liferay.portal.kernel.exception.PortalException, 852 com.liferay.portal.kernel.exception.SystemException { 853 _layoutService.importPortletInfoInBackground(taskName, portletId, 854 parameterMap, is); 855 } 856 857 /** 858 * Schedules a range of layouts to be published. 859 * 860 * @param sourceGroupId the primary key of the source group 861 * @param targetGroupId the primary key of the target group 862 * @param privateLayout whether the layout is private to the group 863 * @param layoutIdMap the layouts considered for publishing, specified by 864 the layout IDs and booleans indicating whether they have children 865 * @param parameterMap the mapping of parameters indicating which 866 information will be used. See {@link 867 com.liferay.portal.kernel.lar.PortletDataHandlerKeys} 868 * @param scope the scope of the pages. It can be <code>all-pages</code> or 869 <code>selected-pages</code>. 870 * @param startDate the start date 871 * @param endDate the end date 872 * @param groupName the group name (optionally {@link 873 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 874 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 875 * @param cronText the cron text. See {@link 876 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 877 * @param schedulerStartDate the scheduler start date 878 * @param schedulerEndDate the scheduler end date 879 * @param description the scheduler description 880 * @throws PortalException if the group did not have permission to manage 881 and publish 882 * @throws SystemException if a system exception occurred 883 */ 884 @Override 885 public void schedulePublishToLive(long sourceGroupId, long targetGroupId, 886 boolean privateLayout, 887 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 888 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 889 java.lang.String scope, java.util.Date startDate, 890 java.util.Date endDate, java.lang.String groupName, 891 java.lang.String cronText, java.util.Date schedulerStartDate, 892 java.util.Date schedulerEndDate, java.lang.String description) 893 throws com.liferay.portal.kernel.exception.PortalException, 894 com.liferay.portal.kernel.exception.SystemException { 895 _layoutService.schedulePublishToLive(sourceGroupId, targetGroupId, 896 privateLayout, layoutIdMap, parameterMap, scope, startDate, 897 endDate, groupName, cronText, schedulerStartDate, schedulerEndDate, 898 description); 899 } 900 901 /** 902 * Schedules a range of layouts to be stored. 903 * 904 * @param sourceGroupId the primary key of the source group 905 * @param privateLayout whether the layout is private to the group 906 * @param layoutIdMap the layouts considered for publishing, specified by 907 the layout IDs and booleans indicating whether they have children 908 * @param parameterMap the mapping of parameters indicating which 909 information will be used. See {@link 910 com.liferay.portal.kernel.lar.PortletDataHandlerKeys} 911 * @param remoteAddress the remote address 912 * @param remotePort the remote port 913 * @param remotePathContext the remote path context 914 * @param secureConnection whether the connection is secure 915 * @param remoteGroupId the primary key of the remote group 916 * @param remotePrivateLayout whether remote group's layout is private 917 * @param startDate the start date 918 * @param endDate the end date 919 * @param groupName the group name. Optionally {@link 920 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 921 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 922 * @param cronText the cron text. See {@link 923 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 924 * @param schedulerStartDate the scheduler start date 925 * @param schedulerEndDate the scheduler end date 926 * @param description the scheduler description 927 * @throws PortalException if a group with the source group primary key was 928 not found or if the group did not have permission to publish 929 * @throws SystemException if a system exception occurred 930 */ 931 @Override 932 public void schedulePublishToRemote(long sourceGroupId, 933 boolean privateLayout, 934 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 935 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 936 java.lang.String remoteAddress, int remotePort, 937 java.lang.String remotePathContext, boolean secureConnection, 938 long remoteGroupId, boolean remotePrivateLayout, 939 java.util.Date startDate, java.util.Date endDate, 940 java.lang.String groupName, java.lang.String cronText, 941 java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, 942 java.lang.String description) 943 throws com.liferay.portal.kernel.exception.PortalException, 944 com.liferay.portal.kernel.exception.SystemException { 945 _layoutService.schedulePublishToRemote(sourceGroupId, privateLayout, 946 layoutIdMap, parameterMap, remoteAddress, remotePort, 947 remotePathContext, secureConnection, remoteGroupId, 948 remotePrivateLayout, startDate, endDate, groupName, cronText, 949 schedulerStartDate, schedulerEndDate, description); 950 } 951 952 /** 953 * Sets the layouts for the group, replacing and prioritizing all layouts of 954 * the parent layout. 955 * 956 * @param groupId the primary key of the group 957 * @param privateLayout whether the layout is private to the group 958 * @param parentLayoutId the primary key of the parent layout 959 * @param layoutIds the primary keys of the layouts 960 * @param serviceContext the service context to be applied 961 * @throws PortalException if a group or layout with the primary key could 962 not be found, if the group did not have permission to manage the 963 layouts, if no layouts were specified, if the first layout was 964 not page-able, if the first layout was hidden, or if some other 965 portal exception occurred 966 * @throws SystemException if a system exception occurred 967 */ 968 @Override 969 public void setLayouts(long groupId, boolean privateLayout, 970 long parentLayoutId, long[] layoutIds, 971 com.liferay.portal.service.ServiceContext serviceContext) 972 throws com.liferay.portal.kernel.exception.PortalException, 973 com.liferay.portal.kernel.exception.SystemException { 974 _layoutService.setLayouts(groupId, privateLayout, parentLayoutId, 975 layoutIds, serviceContext); 976 } 977 978 /** 979 * Deletes the job from the scheduler's queue. 980 * 981 * @param groupId the primary key of the group 982 * @param jobName the job name 983 * @param groupName the group name (optionally {@link 984 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 985 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 986 * @throws PortalException if the group did not permission to manage staging 987 and publish 988 * @throws SystemException if a system exception occurred 989 */ 990 @Override 991 public void unschedulePublishToLive(long groupId, java.lang.String jobName, 992 java.lang.String groupName) 993 throws com.liferay.portal.kernel.exception.PortalException, 994 com.liferay.portal.kernel.exception.SystemException { 995 _layoutService.unschedulePublishToLive(groupId, jobName, groupName); 996 } 997 998 /** 999 * Deletes the job from the scheduler's persistent queue. 1000 * 1001 * @param groupId the primary key of the group 1002 * @param jobName the job name 1003 * @param groupName the group name (optionally {@link 1004 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 1005 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 1006 * @throws PortalException if a group with the primary key could not be 1007 found or if the group did not have permission to publish 1008 * @throws SystemException if a system exception occurred 1009 */ 1010 @Override 1011 public void unschedulePublishToRemote(long groupId, 1012 java.lang.String jobName, java.lang.String groupName) 1013 throws com.liferay.portal.kernel.exception.PortalException, 1014 com.liferay.portal.kernel.exception.SystemException { 1015 _layoutService.unschedulePublishToRemote(groupId, jobName, groupName); 1016 } 1017 1018 /** 1019 * Updates the layout with additional parameters. 1020 * 1021 * @param groupId the primary key of the group 1022 * @param privateLayout whether the layout is private to the group 1023 * @param layoutId the primary key of the layout 1024 * @param parentLayoutId the primary key of the layout's new parent layout 1025 * @param localeNamesMap the layout's locales and localized names 1026 * @param localeTitlesMap the layout's locales and localized titles 1027 * @param descriptionMap the locales and localized descriptions to merge 1028 (optionally <code>null</code>) 1029 * @param keywordsMap the locales and localized keywords to merge 1030 (optionally <code>null</code>) 1031 * @param robotsMap the locales and localized robots to merge (optionally 1032 <code>null</code>) 1033 * @param type the layout's new type (optionally {@link 1034 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 1035 * @param hidden whether the layout is hidden 1036 * @param friendlyURLMap the layout's locales and localized friendly URLs. 1037 To see how the URL is normalized when accessed see {@link 1038 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1039 String)}. 1040 * @param iconImage whether the icon image will be updated 1041 * @param iconBytes the byte array of the layout's new icon image 1042 * @param serviceContext the service context to be applied. Can set the 1043 modification date and expando bridge attributes for the layout. 1044 * @return the updated layout 1045 * @throws PortalException if a group or layout with the primary key could 1046 not be found, if the user did not have permission to update the 1047 layout, if a unique friendly URL could not be generated, if a 1048 valid parent layout ID to use could not be found, or if the 1049 layout parameters were invalid 1050 * @throws SystemException if a system exception occurred 1051 */ 1052 @Override 1053 public com.liferay.portal.model.Layout updateLayout(long groupId, 1054 boolean privateLayout, long layoutId, long parentLayoutId, 1055 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 1056 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 1057 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1058 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1059 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1060 java.lang.String type, boolean hidden, 1061 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 1062 java.lang.Boolean iconImage, byte[] iconBytes, 1063 com.liferay.portal.service.ServiceContext serviceContext) 1064 throws com.liferay.portal.kernel.exception.PortalException, 1065 com.liferay.portal.kernel.exception.SystemException { 1066 return _layoutService.updateLayout(groupId, privateLayout, layoutId, 1067 parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap, 1068 keywordsMap, robotsMap, type, hidden, friendlyURLMap, iconImage, 1069 iconBytes, serviceContext); 1070 } 1071 1072 /** 1073 * Updates the layout with additional parameters. 1074 * 1075 * @param groupId the primary key of the group 1076 * @param privateLayout whether the layout is private to the group 1077 * @param layoutId the primary key of the layout 1078 * @param parentLayoutId the primary key of the layout's new parent 1079 layout 1080 * @param localeNamesMap the layout's locales and localized names 1081 * @param localeTitlesMap the layout's locales and localized titles 1082 * @param descriptionMap the locales and localized descriptions to 1083 merge (optionally <code>null</code>) 1084 * @param keywordsMap the locales and localized keywords to merge 1085 (optionally <code>null</code>) 1086 * @param robotsMap the locales and localized robots to merge 1087 (optionally <code>null</code>) 1088 * @param type the layout's new type (optionally {@link 1089 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 1090 * @param hidden whether the layout is hidden 1091 * @param friendlyURL the layout's locales and new friendly URLs. To 1092 see how the URL is normalized when accessed, see {@link 1093 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1094 String)}. 1095 * @param iconImage whether the icon image will be updated 1096 * @param iconBytes the byte array of the layout's new icon image 1097 * @param serviceContext the service context to be applied. Can set the 1098 modification date and expando bridge attributes for the 1099 layout. 1100 * @return the updated layout 1101 * @throws PortalException if a group or layout with the primary key 1102 could not be found, if the user did not have permission to 1103 update the layout, if a unique friendly URL could not be 1104 generated, if a valid parent layout ID to use could not be 1105 found, or if the layout parameters were invalid 1106 * @throws SystemException if a system exception occurred 1107 * @deprecated As of 6.2.0, replaced by {@link #updateLayout(long, boolean, 1108 long, long, Map, Map, Map, Map, Map, String, boolean, Map, 1109 Boolean, byte[], ServiceContext)} 1110 */ 1111 @Override 1112 public com.liferay.portal.model.Layout updateLayout(long groupId, 1113 boolean privateLayout, long layoutId, long parentLayoutId, 1114 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 1115 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 1116 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1117 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1118 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1119 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 1120 java.lang.Boolean iconImage, byte[] iconBytes, 1121 com.liferay.portal.service.ServiceContext serviceContext) 1122 throws com.liferay.portal.kernel.exception.PortalException, 1123 com.liferay.portal.kernel.exception.SystemException { 1124 return _layoutService.updateLayout(groupId, privateLayout, layoutId, 1125 parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap, 1126 keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage, 1127 iconBytes, serviceContext); 1128 } 1129 1130 /** 1131 * Updates the layout replacing its type settings. 1132 * 1133 * @param groupId the primary key of the group 1134 * @param privateLayout whether the layout is private to the group 1135 * @param layoutId the primary key of the layout 1136 * @param typeSettings the settings to load the unicode properties object. 1137 See {@link com.liferay.portal.kernel.util.UnicodeProperties 1138 #fastLoad(String)}. 1139 * @return the updated layout 1140 * @throws PortalException if a matching layout could not be found or if the 1141 user did not have permission to update the layout 1142 * @throws SystemException if a system exception occurred 1143 */ 1144 @Override 1145 public com.liferay.portal.model.Layout updateLayout(long groupId, 1146 boolean privateLayout, long layoutId, java.lang.String typeSettings) 1147 throws com.liferay.portal.kernel.exception.PortalException, 1148 com.liferay.portal.kernel.exception.SystemException { 1149 return _layoutService.updateLayout(groupId, privateLayout, layoutId, 1150 typeSettings); 1151 } 1152 1153 /** 1154 * Updates the look and feel of the layout. 1155 * 1156 * @param groupId the primary key of the group 1157 * @param privateLayout whether the layout is private to the group 1158 * @param layoutId the primary key of the layout 1159 * @param themeId the primary key of the layout's new theme 1160 * @param colorSchemeId the primary key of the layout's new color scheme 1161 * @param css the layout's new CSS 1162 * @param wapTheme whether the theme is for WAP browsers 1163 * @return the updated layout 1164 * @throws PortalException if a matching layout could not be found, or if 1165 the user did not have permission to update the layout and 1166 permission to apply the theme 1167 * @throws SystemException if a system exception occurred 1168 */ 1169 @Override 1170 public com.liferay.portal.model.Layout updateLookAndFeel(long groupId, 1171 boolean privateLayout, long layoutId, java.lang.String themeId, 1172 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 1173 throws com.liferay.portal.kernel.exception.PortalException, 1174 com.liferay.portal.kernel.exception.SystemException { 1175 return _layoutService.updateLookAndFeel(groupId, privateLayout, 1176 layoutId, themeId, colorSchemeId, css, wapTheme); 1177 } 1178 1179 /** 1180 * Updates the name of the layout matching the group, layout ID, and 1181 * privacy. 1182 * 1183 * @param groupId the primary key of the group 1184 * @param privateLayout whether the layout is private to the group 1185 * @param layoutId the primary key of the layout 1186 * @param name the layout's new name 1187 * @param languageId the primary key of the language. For more information 1188 see {@link java.util.Locale}. 1189 * @return the updated layout 1190 * @throws PortalException if a matching layout could not be found, if the 1191 user did not have permission to update the layout, or if the new 1192 name was <code>null</code> 1193 * @throws SystemException if a system exception occurred 1194 */ 1195 @Override 1196 public com.liferay.portal.model.Layout updateName(long groupId, 1197 boolean privateLayout, long layoutId, java.lang.String name, 1198 java.lang.String languageId) 1199 throws com.liferay.portal.kernel.exception.PortalException, 1200 com.liferay.portal.kernel.exception.SystemException { 1201 return _layoutService.updateName(groupId, privateLayout, layoutId, 1202 name, languageId); 1203 } 1204 1205 /** 1206 * Updates the name of the layout matching the primary key. 1207 * 1208 * @param plid the primary key of the layout 1209 * @param name the name to be assigned 1210 * @param languageId the primary key of the language. For more information 1211 see {@link java.util.Locale}. 1212 * @return the updated layout 1213 * @throws PortalException if a layout with the primary key could not be 1214 found, or if the user did not have permission to update the 1215 layout, or if the name was <code>null</code> 1216 * @throws SystemException if a system exception occurred 1217 */ 1218 @Override 1219 public com.liferay.portal.model.Layout updateName(long plid, 1220 java.lang.String name, java.lang.String languageId) 1221 throws com.liferay.portal.kernel.exception.PortalException, 1222 com.liferay.portal.kernel.exception.SystemException { 1223 return _layoutService.updateName(plid, name, languageId); 1224 } 1225 1226 /** 1227 * Updates the parent layout ID of the layout matching the group, layout ID, 1228 * and privacy. 1229 * 1230 * @param groupId the primary key of the group 1231 * @param privateLayout whether the layout is private to the group 1232 * @param layoutId the primary key of the layout 1233 * @param parentLayoutId the primary key to be assigned to the parent 1234 layout 1235 * @return the matching layout 1236 * @throws PortalException if a valid parent layout ID to use could not be 1237 found, if a matching layout could not be found, or if the user 1238 did not have permission to update the layout 1239 * @throws SystemException if a system exception occurred 1240 */ 1241 @Override 1242 public com.liferay.portal.model.Layout updateParentLayoutId(long groupId, 1243 boolean privateLayout, long layoutId, long parentLayoutId) 1244 throws com.liferay.portal.kernel.exception.PortalException, 1245 com.liferay.portal.kernel.exception.SystemException { 1246 return _layoutService.updateParentLayoutId(groupId, privateLayout, 1247 layoutId, parentLayoutId); 1248 } 1249 1250 /** 1251 * Updates the parent layout ID of the layout matching the primary key. If a 1252 * layout matching the parent primary key is found, the layout ID of that 1253 * layout is assigned, otherwise {@link 1254 * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is 1255 * assigned. 1256 * 1257 * @param plid the primary key of the layout 1258 * @param parentPlid the primary key of the parent layout 1259 * @return the layout matching the primary key 1260 * @throws PortalException if a layout with the primary key could not be 1261 found, if the user did not have permission to update the layout, 1262 or if a valid parent layout ID to use could not be found 1263 * @throws SystemException if a system exception occurred 1264 */ 1265 @Override 1266 public com.liferay.portal.model.Layout updateParentLayoutId(long plid, 1267 long parentPlid) 1268 throws com.liferay.portal.kernel.exception.PortalException, 1269 com.liferay.portal.kernel.exception.SystemException { 1270 return _layoutService.updateParentLayoutId(plid, parentPlid); 1271 } 1272 1273 /** 1274 * Updates the priority of the layout matching the group, layout ID, and 1275 * privacy. 1276 * 1277 * @param groupId the primary key of the group 1278 * @param privateLayout whether the layout is private to the group 1279 * @param layoutId the primary key of the layout 1280 * @param priority the layout's new priority 1281 * @return the updated layout 1282 * @throws PortalException if a matching layout could not be found or if the 1283 user did not have permission to update the layout 1284 * @throws SystemException if a system exception occurred 1285 */ 1286 @Override 1287 public com.liferay.portal.model.Layout updatePriority(long groupId, 1288 boolean privateLayout, long layoutId, int priority) 1289 throws com.liferay.portal.kernel.exception.PortalException, 1290 com.liferay.portal.kernel.exception.SystemException { 1291 return _layoutService.updatePriority(groupId, privateLayout, layoutId, 1292 priority); 1293 } 1294 1295 /** 1296 * Updates the priority of the layout matching the group, layout ID, and 1297 * privacy, setting the layout's priority based on the priorities of the 1298 * next and previous layouts. 1299 * 1300 * @param groupId the primary key of the group 1301 * @param privateLayout whether the layout is private to the group 1302 * @param layoutId the primary key of the layout 1303 * @param nextLayoutId the primary key of the next layout 1304 * @param previousLayoutId the primary key of the previous layout 1305 * @return the updated layout 1306 * @throws PortalException if a matching layout could not be found or if the 1307 user did not have permission to update the layout 1308 * @throws SystemException if a system exception occurred 1309 */ 1310 @Override 1311 public com.liferay.portal.model.Layout updatePriority(long groupId, 1312 boolean privateLayout, long layoutId, long nextLayoutId, 1313 long previousLayoutId) 1314 throws com.liferay.portal.kernel.exception.PortalException, 1315 com.liferay.portal.kernel.exception.SystemException { 1316 return _layoutService.updatePriority(groupId, privateLayout, layoutId, 1317 nextLayoutId, previousLayoutId); 1318 } 1319 1320 /** 1321 * Updates the priority of the layout matching the primary key. 1322 * 1323 * @param plid the primary key of the layout 1324 * @param priority the layout's new priority 1325 * @return the updated layout 1326 * @throws PortalException if a layout with the primary key could not be 1327 found 1328 * @throws SystemException if a system exception occurred 1329 */ 1330 @Override 1331 public com.liferay.portal.model.Layout updatePriority(long plid, 1332 int priority) 1333 throws com.liferay.portal.kernel.exception.PortalException, 1334 com.liferay.portal.kernel.exception.SystemException { 1335 return _layoutService.updatePriority(plid, priority); 1336 } 1337 1338 @Override 1339 public com.liferay.portal.kernel.lar.MissingReferences validateImportLayoutsFile( 1340 long groupId, boolean privateLayout, 1341 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1342 java.io.File file) 1343 throws com.liferay.portal.kernel.exception.PortalException, 1344 com.liferay.portal.kernel.exception.SystemException { 1345 return _layoutService.validateImportLayoutsFile(groupId, privateLayout, 1346 parameterMap, file); 1347 } 1348 1349 @Override 1350 public com.liferay.portal.kernel.lar.MissingReferences validateImportLayoutsFile( 1351 long groupId, boolean privateLayout, 1352 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1353 java.io.InputStream inputStream) 1354 throws com.liferay.portal.kernel.exception.PortalException, 1355 com.liferay.portal.kernel.exception.SystemException { 1356 return _layoutService.validateImportLayoutsFile(groupId, privateLayout, 1357 parameterMap, inputStream); 1358 } 1359 1360 @Override 1361 public com.liferay.portal.kernel.lar.MissingReferences validateImportPortletInfo( 1362 long plid, long groupId, java.lang.String portletId, 1363 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1364 java.io.File file) 1365 throws com.liferay.portal.kernel.exception.PortalException, 1366 com.liferay.portal.kernel.exception.SystemException { 1367 return _layoutService.validateImportPortletInfo(plid, groupId, 1368 portletId, parameterMap, file); 1369 } 1370 1371 @Override 1372 public com.liferay.portal.kernel.lar.MissingReferences validateImportPortletInfo( 1373 long plid, long groupId, java.lang.String portletId, 1374 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1375 java.io.InputStream inputStream) 1376 throws com.liferay.portal.kernel.exception.PortalException, 1377 com.liferay.portal.kernel.exception.SystemException { 1378 return _layoutService.validateImportPortletInfo(plid, groupId, 1379 portletId, parameterMap, inputStream); 1380 } 1381 1382 /** 1383 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 1384 */ 1385 public LayoutService getWrappedLayoutService() { 1386 return _layoutService; 1387 } 1388 1389 /** 1390 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 1391 */ 1392 public void setWrappedLayoutService(LayoutService layoutService) { 1393 _layoutService = layoutService; 1394 } 1395 1396 @Override 1397 public LayoutService getWrappedService() { 1398 return _layoutService; 1399 } 1400 1401 @Override 1402 public void setWrappedService(LayoutService layoutService) { 1403 _layoutService = layoutService; 1404 } 1405 1406 private LayoutService _layoutService; 1407 }