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