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