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