001 /** 002 * Copyright (c) 2000-2012 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 * <p> 019 * This class is a wrapper for {@link LayoutService}. 020 * </p> 021 * 022 * @author Brian Wing Shun Chan 023 * @see LayoutService 024 * @generated 025 */ 026 public class LayoutServiceWrapper implements LayoutService, 027 ServiceWrapper<LayoutService> { 028 public LayoutServiceWrapper(LayoutService layoutService) { 029 _layoutService = layoutService; 030 } 031 032 /** 033 * Returns the Spring bean ID for this bean. 034 * 035 * @return the Spring bean ID for this bean 036 */ 037 public java.lang.String getBeanIdentifier() { 038 return _layoutService.getBeanIdentifier(); 039 } 040 041 /** 042 * Sets the Spring bean ID for this bean. 043 * 044 * @param beanIdentifier the Spring bean ID for this bean 045 */ 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 (optionally 063 {@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 descriptions 068 * @param keywordsMap the layout's locales and localized keywords 069 * @param robotsMap the layout's locales and localized robots 070 * @param type the layout's type (optionally {@link 071 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The 072 possible types can be found in {@link 073 com.liferay.portal.model.LayoutConstants}. 074 * @param hidden whether the layout is hidden 075 * @param friendlyURL the layout's friendly URL (optionally {@link 076 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} 077 or {@link 078 com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). 079 The default values can be overridden in 080 <code>portal-ext.properties</code> by specifying new values for 081 the corresponding properties defined in {@link 082 com.liferay.portal.util.PropsValues}. To see how the URL is 083 normalized when accessed see {@link 084 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 085 String)}. 086 * @param serviceContext the service context. Must set the universally 087 unique identifier (UUID) for the layout. Can set the creation 088 date, modification date and the expando bridge attributes for the 089 layout. For layouts that belong to a layout set prototype, an 090 attribute named 'layoutUpdateable' can be used to specify whether 091 site administrators can modify this page within their site. 092 * @return the layout 093 * @throws PortalException if a group with the primary key could not be 094 found, if the group did not have permission to manage the layouts 095 involved, or if layout values were invalid 096 * @throws SystemException if a system exception occurred 097 */ 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 empty maps for descriptions, keywords, and titles , 116 * and a names map containing a mapping for the default locale as its only 117 * entry. 118 * 119 * <p> 120 * This method handles the creation of the layout including its resources, 121 * metadata, and internal data structures. It is not necessary to make 122 * subsequent calls to any methods to setup default groups, resources, ... 123 * etc. 124 * </p> 125 * 126 * @param groupId the primary key of the group 127 * @param privateLayout whether the layout is private to the group 128 * @param parentLayoutId the primary key of the parent layout (optionally 129 {@link 130 com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 131 * @param name Map the layout's locales and localized names 132 * @param title Map the layout's locales and localized titles 133 * @param description Map the layout's locales and localized descriptions 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 hidden whether the layout is hidden 139 * @param friendlyURL the layout's friendly URL (optionally {@link 140 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} 141 or {@link 142 com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). 143 The default values can be overridden in 144 <code>portal-ext.properties</code> by specifying new values for 145 the corresponding properties defined in {@link 146 com.liferay.portal.util.PropsValues}. To see how the URL is 147 normalized when accessed see {@link 148 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 149 String)}. 150 * @param serviceContext the service context. Must set the universally 151 unique identifier (UUID) for the layout. Can specify the creation 152 date, modification date and the expando bridge attributes for the 153 layout. For layouts that belong to a layout set prototype, an 154 attribute named 'layoutUpdateable' can be used to specify whether 155 site administrators can modify this page within their site. 156 * @return the layout 157 * @throws PortalException if a group with the primary key could not be 158 found, if the group did not have permission to manage the layouts 159 involved, or if layout values were invalid 160 * @throws SystemException if a system exception occurred 161 */ 162 public com.liferay.portal.model.Layout addLayout(long groupId, 163 boolean privateLayout, long parentLayoutId, java.lang.String name, 164 java.lang.String title, java.lang.String description, 165 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 166 com.liferay.portal.service.ServiceContext serviceContext) 167 throws com.liferay.portal.kernel.exception.PortalException, 168 com.liferay.portal.kernel.exception.SystemException { 169 return _layoutService.addLayout(groupId, privateLayout, parentLayoutId, 170 name, title, description, type, hidden, friendlyURL, serviceContext); 171 } 172 173 /** 174 * Deletes the layout with the primary key, also deleting the layout's child 175 * layouts, and associated resources. 176 * 177 * @param groupId the primary key of the group 178 * @param privateLayout whether the layout is private to the group 179 * @param layoutId the primary key of the layout 180 * @param serviceContext the service context 181 * @throws PortalException if the user did not have permission to delete the 182 layout, if a matching layout could not be found , or if some 183 other portal exception occurred 184 * @throws SystemException if a system exception occurred 185 */ 186 public void deleteLayout(long groupId, boolean privateLayout, 187 long layoutId, com.liferay.portal.service.ServiceContext serviceContext) 188 throws com.liferay.portal.kernel.exception.PortalException, 189 com.liferay.portal.kernel.exception.SystemException { 190 _layoutService.deleteLayout(groupId, privateLayout, layoutId, 191 serviceContext); 192 } 193 194 /** 195 * Deletes the layout with the plid, also deleting the layout's child 196 * layouts, and associated resources. 197 * 198 * @param plid the primary key of the layout 199 * @param serviceContext the service context 200 * @throws PortalException if the user did not have permission to delete the 201 layout, if a layout with the primary key could not be found , or 202 if some other portal exception occurred 203 * @throws SystemException if a system exception occurred 204 */ 205 public void deleteLayout(long plid, 206 com.liferay.portal.service.ServiceContext serviceContext) 207 throws com.liferay.portal.kernel.exception.PortalException, 208 com.liferay.portal.kernel.exception.SystemException { 209 _layoutService.deleteLayout(plid, serviceContext); 210 } 211 212 /** 213 * Exports the layouts that match the primary keys and the criteria as a 214 * byte array. 215 * 216 * @param groupId the primary key of the group 217 * @param privateLayout whether the layout is private to the group 218 * @param layoutIds the primary keys of the layouts to be exported 219 * @param parameterMap the mapping of parameters indicating which 220 information to export. For information on the keys used in the 221 map see {@link 222 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 223 * @param startDate the export's start date 224 * @param endDate the export's end date 225 * @return the layouts as a byte array 226 * @throws PortalException if a group or any layout with the primary key 227 could not be found, if the group did not have permission to 228 manage the layouts, or if some other portal exception occurred 229 * @throws SystemException if a system exception occurred 230 */ 231 public byte[] exportLayouts(long groupId, boolean privateLayout, 232 long[] layoutIds, 233 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 234 java.util.Date startDate, java.util.Date endDate) 235 throws com.liferay.portal.kernel.exception.PortalException, 236 com.liferay.portal.kernel.exception.SystemException { 237 return _layoutService.exportLayouts(groupId, privateLayout, layoutIds, 238 parameterMap, startDate, endDate); 239 } 240 241 /** 242 * Exports all layouts that match the criteria as a byte array. 243 * 244 * @param groupId the primary key of the group 245 * @param privateLayout whether the layout is private to the group 246 * @param parameterMap the mapping of parameters indicating which 247 information to export. For information on the keys used in the 248 map see {@link 249 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 250 * @param startDate the export's start date 251 * @param endDate the export's end date 252 * @return the layout as a byte array 253 * @throws PortalException if a group with the primary key could not be 254 found, if the group did not have permission to manage the 255 layouts, or if some other portal exception occurred 256 * @throws SystemException if a system exception occurred 257 */ 258 public byte[] exportLayouts(long groupId, boolean privateLayout, 259 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 260 java.util.Date startDate, java.util.Date endDate) 261 throws com.liferay.portal.kernel.exception.PortalException, 262 com.liferay.portal.kernel.exception.SystemException { 263 return _layoutService.exportLayouts(groupId, privateLayout, 264 parameterMap, startDate, endDate); 265 } 266 267 /** 268 * Exports all layouts that match the primary keys and criteria as a file. 269 * 270 * @param groupId the primary key of the group 271 * @param privateLayout whether the layout is private to the group 272 * @param layoutIds the primary keys of the layouts to be exported 273 (optionally <code>null</code>) 274 * @param parameterMap the mapping of parameters indicating which 275 information to export. For information on the keys used in the 276 map see {@link 277 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 278 * @param startDate the export's start date 279 * @param endDate the export's end date 280 * @return the layouts as a File 281 * @throws PortalException if a group or any layout with the primary key 282 could not be found, it the group did not have permission to 283 manage the layouts, or if some other portal exception occurred 284 * @throws SystemException if a system exception occurred 285 */ 286 public java.io.File exportLayoutsAsFile(long groupId, 287 boolean privateLayout, long[] layoutIds, 288 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 289 java.util.Date startDate, java.util.Date endDate) 290 throws com.liferay.portal.kernel.exception.PortalException, 291 com.liferay.portal.kernel.exception.SystemException { 292 return _layoutService.exportLayoutsAsFile(groupId, privateLayout, 293 layoutIds, parameterMap, startDate, endDate); 294 } 295 296 /** 297 * Exports the portlet information (categories, permissions, ... etc.) as a 298 * byte array. 299 * 300 * @param plid the primary key of the layout 301 * @param groupId the primary key of the group 302 * @param portletId the primary key of the portlet 303 * @param parameterMap the mapping of parameters indicating which 304 information to export. For information on the keys used in the 305 map see {@link 306 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 307 * @param startDate the export's start date 308 * @param endDate the export's end date 309 * @return the portlet information as a byte array 310 * @throws PortalException if a layout, group, or portlet with the primary 311 key could not be found, if the group did not have permission to 312 manage the layouts involved, or if some other portal exception 313 occurred 314 * @throws SystemException if a system exception occurred 315 */ 316 public byte[] exportPortletInfo(long plid, long groupId, 317 java.lang.String portletId, 318 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 319 java.util.Date startDate, java.util.Date endDate) 320 throws com.liferay.portal.kernel.exception.PortalException, 321 com.liferay.portal.kernel.exception.SystemException { 322 return _layoutService.exportPortletInfo(plid, groupId, portletId, 323 parameterMap, startDate, endDate); 324 } 325 326 /** 327 * Exports the portlet information (categories, permissions, ... etc.) as a 328 * file. 329 * 330 * @param plid the primary key of the layout 331 * @param groupId the primary key of the group 332 * @param portletId the primary key of the portlet 333 * @param parameterMap the mapping of parameters indicating which 334 information to export. For information on the keys used in the 335 map see {@link 336 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 337 * @param startDate the export's start date 338 * @param endDate the export's end date 339 * @return the portlet information as a file 340 * @throws PortalException if a layout, group, or portlet with the primary 341 key could not be found, it the group did not have permission to 342 manage the layouts involved, or if some other portal exception 343 occurred 344 * @throws SystemException if a system exception occurred 345 */ 346 public java.io.File exportPortletInfoAsFile(long plid, long groupId, 347 java.lang.String portletId, 348 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 349 java.util.Date startDate, java.util.Date endDate) 350 throws com.liferay.portal.kernel.exception.PortalException, 351 com.liferay.portal.kernel.exception.SystemException { 352 return _layoutService.exportPortletInfoAsFile(plid, groupId, portletId, 353 parameterMap, startDate, endDate); 354 } 355 356 /** 357 * Returns the primary key of the default layout for the group. 358 * 359 * @param groupId the primary key of the group 360 * @param scopeGroupId the primary key of the scope group. See {@link 361 com.liferay.portal.service.ServiceContext#getScopeGroupId()}. 362 * @param privateLayout whether the layout is private to the group 363 * @param portletId the primary key of the portlet 364 * @return Returns the primary key of the default layout group; {@link 365 com.liferay.portal.model.LayoutConstants#DEFAULT_PLID} otherwise 366 * @throws PortalException if a group, layout, or portlet with the primary 367 key could not be found 368 * @throws SystemException if a system exception occurred 369 */ 370 public long getDefaultPlid(long groupId, long scopeGroupId, 371 boolean privateLayout, java.lang.String portletId) 372 throws com.liferay.portal.kernel.exception.PortalException, 373 com.liferay.portal.kernel.exception.SystemException { 374 return _layoutService.getDefaultPlid(groupId, scopeGroupId, 375 privateLayout, portletId); 376 } 377 378 /** 379 * Returns the name of the layout. 380 * 381 * @param groupId the primary key of the group 382 * @param privateLayout whether the layout is private to the group 383 * @param layoutId the primary key of the layout 384 * @param languageId the primary key of the language. For more information 385 See {@link java.util.Locale}. 386 * @return the layout's name 387 * @throws PortalException if a matching layout could not be found 388 * @throws SystemException if a system exception occurred 389 */ 390 public java.lang.String getLayoutName(long groupId, boolean privateLayout, 391 long layoutId, java.lang.String languageId) 392 throws com.liferay.portal.kernel.exception.PortalException, 393 com.liferay.portal.kernel.exception.SystemException { 394 return _layoutService.getLayoutName(groupId, privateLayout, layoutId, 395 languageId); 396 } 397 398 /** 399 * Returns the layout references for all the layouts that belong to the 400 * company and belong to the portlet that matches the preferences. 401 * 402 * @param companyId the primary key of the company 403 * @param portletId the primary key of the portlet 404 * @param preferencesKey the portlet's preference key 405 * @param preferencesValue the portlet's preference value 406 * @return the layout references of the matching layouts 407 * @throws SystemException if a system exception occurred 408 */ 409 public com.liferay.portal.model.LayoutReference[] getLayoutReferences( 410 long companyId, java.lang.String portletId, 411 java.lang.String preferencesKey, java.lang.String preferencesValue) 412 throws com.liferay.portal.kernel.exception.SystemException { 413 return _layoutService.getLayoutReferences(companyId, portletId, 414 preferencesKey, preferencesValue); 415 } 416 417 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 418 long groupId, boolean privateLayout) 419 throws com.liferay.portal.kernel.exception.PortalException, 420 com.liferay.portal.kernel.exception.SystemException { 421 return _layoutService.getLayouts(groupId, privateLayout); 422 } 423 424 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 425 long groupId, boolean privateLayout, long parentLayoutId) 426 throws com.liferay.portal.kernel.exception.PortalException, 427 com.liferay.portal.kernel.exception.SystemException { 428 return _layoutService.getLayouts(groupId, privateLayout, parentLayoutId); 429 } 430 431 /** 432 * Imports the layouts from the byte array. 433 * 434 * @param groupId the primary key of the group 435 * @param privateLayout whether the layout is private to the group 436 * @param parameterMap the mapping of parameters indicating which 437 information will be imported. For information on the keys used in 438 the map see {@link 439 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 440 * @param bytes the byte array with the data 441 * @throws PortalException if a group with the primary key could not be 442 found, if the group did not have permission to manage the 443 layouts, or if some other portal exception occurred 444 * @throws SystemException if a system exception occurred 445 * @see com.liferay.portal.lar.LayoutImporter 446 */ 447 public void importLayouts(long groupId, boolean privateLayout, 448 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 449 byte[] bytes) 450 throws com.liferay.portal.kernel.exception.PortalException, 451 com.liferay.portal.kernel.exception.SystemException { 452 _layoutService.importLayouts(groupId, privateLayout, parameterMap, bytes); 453 } 454 455 /** 456 * Imports the layouts from the file. 457 * 458 * @param groupId the primary key of the group 459 * @param privateLayout whether the layout is private to the group 460 * @param parameterMap the mapping of parameters indicating which 461 information will be imported. For information on the keys used in 462 the map see {@link 463 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 464 * @param file the LAR file with the data 465 * @throws PortalException if a group with the primary key could not be 466 found, if the group did not have permission to manage the layouts 467 and publish, or if some other portal exception occurred 468 * @throws SystemException if a system exception occurred 469 * @see com.liferay.portal.lar.LayoutImporter 470 */ 471 public void importLayouts(long groupId, boolean privateLayout, 472 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 473 java.io.File file) 474 throws com.liferay.portal.kernel.exception.PortalException, 475 com.liferay.portal.kernel.exception.SystemException { 476 _layoutService.importLayouts(groupId, privateLayout, parameterMap, file); 477 } 478 479 /** 480 * Imports the layouts from the input stream. 481 * 482 * @param groupId the primary key of the group 483 * @param privateLayout whether the layout is private to the group 484 * @param parameterMap the mapping of parameters indicating which 485 information will be imported. For information on the keys used in 486 the map see {@link 487 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 488 * @param is the input stream 489 * @throws PortalException if a group with the primary key could not be 490 found, if the group did not have permission to manage the 491 layouts, or if some other portal exception occurred 492 * @throws SystemException if a system exception occurred 493 * @see com.liferay.portal.lar.LayoutImporter 494 */ 495 public void importLayouts(long groupId, boolean privateLayout, 496 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 497 java.io.InputStream is) 498 throws com.liferay.portal.kernel.exception.PortalException, 499 com.liferay.portal.kernel.exception.SystemException { 500 _layoutService.importLayouts(groupId, privateLayout, parameterMap, is); 501 } 502 503 /** 504 * Imports the portlet information (categories, permissions, ... etc.) from 505 * the file. 506 * 507 * @param plid the primary key of the layout 508 * @param groupId the primary key of the group 509 * @param portletId the primary key of the portlet 510 * @param parameterMap the mapping of parameters indicating which 511 information will be imported. For information on the keys used in 512 the map see {@link 513 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 514 * @param file the LAR file with the data 515 * @throws PortalException if a group, layout, or portlet with the primary 516 key could not be found, or if the group did not have permission 517 to manage the layouts 518 * @throws SystemException if a system exception occurred 519 */ 520 public void importPortletInfo(long plid, long groupId, 521 java.lang.String portletId, 522 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 523 java.io.File file) 524 throws com.liferay.portal.kernel.exception.PortalException, 525 com.liferay.portal.kernel.exception.SystemException { 526 _layoutService.importPortletInfo(plid, groupId, portletId, 527 parameterMap, file); 528 } 529 530 /** 531 * Imports the portlet information (categories, permissions, ... etc.) from 532 * the input stream. 533 * 534 * @param plid the primary key of the layout 535 * @param groupId the primary key of the group 536 * @param portletId the primary key of the portlet 537 * @param parameterMap the mapping of parameters indicating which 538 information will be imported. For information on the keys used in 539 the map see {@link 540 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 541 * @param is the input stream 542 * @throws PortalException if a group, portlet, or layout with the primary 543 key could not be found or if the group did not have permission to 544 manage the layouts 545 * @throws SystemException if a system exception occurred 546 */ 547 public void importPortletInfo(long plid, long groupId, 548 java.lang.String portletId, 549 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 550 java.io.InputStream is) 551 throws com.liferay.portal.kernel.exception.PortalException, 552 com.liferay.portal.kernel.exception.SystemException { 553 _layoutService.importPortletInfo(plid, groupId, portletId, 554 parameterMap, is); 555 } 556 557 /** 558 * Schedules a range of layouts to be published. 559 * 560 * @param sourceGroupId the primary key of the source group 561 * @param targetGroupId the primary key of the target group 562 * @param privateLayout whether the layout is private to the group 563 * @param layoutIdMap the layouts considered for publishing, specified by 564 the layout IDs and booleans indicating whether they have children 565 * @param parameterMap the mapping of parameters indicating which 566 information will be used. See {@link 567 com.liferay.portal.kernel.lar.PortletDataHandlerKeys} 568 * @param scope the scope of the pages. It can be <code>all-pages</code> or 569 <code>selected-pages</code>. 570 * @param startDate the start date 571 * @param endDate the end date 572 * @param groupName the group name (optionally {@link 573 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 574 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 575 * @param cronText the cron text. See {@link 576 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 577 * @param schedulerStartDate the scheduler start date 578 * @param schedulerEndDate the scheduler end date 579 * @param description the scheduler description 580 * @throws PortalException if the group did not have permission to manage 581 and publish 582 * @throws SystemException if a system exception occurred 583 */ 584 public void schedulePublishToLive(long sourceGroupId, long targetGroupId, 585 boolean privateLayout, 586 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 587 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 588 java.lang.String scope, java.util.Date startDate, 589 java.util.Date endDate, java.lang.String groupName, 590 java.lang.String cronText, java.util.Date schedulerStartDate, 591 java.util.Date schedulerEndDate, java.lang.String description) 592 throws com.liferay.portal.kernel.exception.PortalException, 593 com.liferay.portal.kernel.exception.SystemException { 594 _layoutService.schedulePublishToLive(sourceGroupId, targetGroupId, 595 privateLayout, layoutIdMap, parameterMap, scope, startDate, 596 endDate, groupName, cronText, schedulerStartDate, schedulerEndDate, 597 description); 598 } 599 600 /** 601 * Schedules a range of layouts to be stored. 602 * 603 * @param sourceGroupId the primary key of the source group 604 * @param privateLayout whether the layout is private to the group 605 * @param layoutIdMap the layouts considered for publishing, specified by 606 the layout IDs and booleans indicating whether they have children 607 * @param parameterMap the mapping of parameters indicating which 608 information will be used. See {@link 609 com.liferay.portal.kernel.lar.PortletDataHandlerKeys} 610 * @param remoteAddress the remote address 611 * @param remotePort the remote port 612 * @param remotePathContext the remote path context 613 * @param secureConnection whether the connection is secure 614 * @param remoteGroupId the primary key of the remote group 615 * @param remotePrivateLayout whether remote group's layout is private 616 * @param startDate the start date 617 * @param endDate the end date 618 * @param groupName the group name. Optionally {@link 619 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 620 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 621 * @param cronText the cron text. See {@link 622 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 623 * @param schedulerStartDate the scheduler start date 624 * @param schedulerEndDate the scheduler end date 625 * @param description the scheduler description 626 * @throws PortalException if a group with the source group primary key was 627 not found or if the group did not have permission to publish 628 * @throws SystemException if a system exception occurred 629 */ 630 public void schedulePublishToRemote(long sourceGroupId, 631 boolean privateLayout, 632 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 633 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 634 java.lang.String remoteAddress, int remotePort, 635 java.lang.String remotePathContext, boolean secureConnection, 636 long remoteGroupId, boolean remotePrivateLayout, 637 java.util.Date startDate, java.util.Date endDate, 638 java.lang.String groupName, java.lang.String cronText, 639 java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, 640 java.lang.String description) 641 throws com.liferay.portal.kernel.exception.PortalException, 642 com.liferay.portal.kernel.exception.SystemException { 643 _layoutService.schedulePublishToRemote(sourceGroupId, privateLayout, 644 layoutIdMap, parameterMap, remoteAddress, remotePort, 645 remotePathContext, secureConnection, remoteGroupId, 646 remotePrivateLayout, startDate, endDate, groupName, cronText, 647 schedulerStartDate, schedulerEndDate, description); 648 } 649 650 /** 651 * Sets the layouts for the group, replacing and prioritizing all layouts of 652 * the parent layout. 653 * 654 * @param groupId the primary key of the group 655 * @param privateLayout whether the layout is private to the group 656 * @param parentLayoutId the primary key of the parent layout 657 * @param layoutIds the primary keys of the layouts 658 * @param serviceContext the service context 659 * @throws PortalException if a group or layout with the primary key could 660 not be found, if the group did not have permission to manage the 661 layouts, if no layouts were specified, if the first layout was 662 not page-able, if the first layout was hidden, or if some other 663 portal exception occurred 664 * @throws SystemException if a system exception occurred 665 */ 666 public void setLayouts(long groupId, boolean privateLayout, 667 long parentLayoutId, long[] layoutIds, 668 com.liferay.portal.service.ServiceContext serviceContext) 669 throws com.liferay.portal.kernel.exception.PortalException, 670 com.liferay.portal.kernel.exception.SystemException { 671 _layoutService.setLayouts(groupId, privateLayout, parentLayoutId, 672 layoutIds, serviceContext); 673 } 674 675 /** 676 * Deletes the job from the scheduler's queue. 677 * 678 * @param groupId the primary key of the group 679 * @param jobName the job name 680 * @param groupName the group name (optionally {@link 681 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 682 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 683 * @throws PortalException if the group did not permission to manage staging 684 and publish 685 * @throws SystemException if a system exception occurred 686 */ 687 public void unschedulePublishToLive(long groupId, java.lang.String jobName, 688 java.lang.String groupName) 689 throws com.liferay.portal.kernel.exception.PortalException, 690 com.liferay.portal.kernel.exception.SystemException { 691 _layoutService.unschedulePublishToLive(groupId, jobName, groupName); 692 } 693 694 /** 695 * Deletes the job from the scheduler's persistent queue. 696 * 697 * @param groupId the primary key of the group 698 * @param jobName the job name 699 * @param groupName the group name (optionally {@link 700 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 701 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 702 * @throws PortalException if a group with the primary key could not be 703 found or if the group did not have permission to publish 704 * @throws SystemException if a system exception occurred 705 */ 706 public void unschedulePublishToRemote(long groupId, 707 java.lang.String jobName, java.lang.String groupName) 708 throws com.liferay.portal.kernel.exception.PortalException, 709 com.liferay.portal.kernel.exception.SystemException { 710 _layoutService.unschedulePublishToRemote(groupId, jobName, groupName); 711 } 712 713 /** 714 * Updates the layout. 715 * 716 * @param groupId the primary key of the group 717 * @param privateLayout whether the layout is private to the group 718 * @param layoutId the primary key of the layout 719 * @param parentLayoutId the primary key of the layout's new parent layout 720 * @param localeNamesMap the layout's locales and localized names 721 * @param localeTitlesMap the layout's locales and localized titles 722 * @param descriptionMap the locales and localized descriptions to merge 723 (optionally <code>null</code>) 724 * @param keywordsMap the locales and localized keywords to merge 725 (optionally <code>null</code>) 726 * @param robotsMap the locales and localized robots to merge (optionally 727 <code>null</code>) 728 * @param type the layout's new type (optionally {@link 729 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 730 * @param hidden whether the layout is hidden 731 * @param friendlyURL the layout's new friendly URL (optionally {@link 732 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} 733 or {@link 734 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}). 735 The default values can be overridden in 736 <code>portal-ext.properties</code> by specifying new values for 737 the corresponding properties defined in {@link 738 com.liferay.portal.util.PropsValues}. To see how the URL is 739 normalized when accessed see {@link 740 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 741 String)}. 742 * @param iconImage whether the icon image will be updated 743 * @param iconBytes the byte array of the layout's new icon image 744 * @param serviceContext the service context. Can set the modification date 745 and expando bridge attributes for the layout. 746 * @return the updated layout 747 * @throws PortalException if a group or layout with the primary key could 748 not be found, if the user did not have permission to update the 749 layout, if a unique friendly URL could not be generated, if a 750 valid parent layout ID to use could not be found, or if the 751 layout parameters were invalid 752 * @throws SystemException if a system exception occurred 753 */ 754 public com.liferay.portal.model.Layout updateLayout(long groupId, 755 boolean privateLayout, long layoutId, long parentLayoutId, 756 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 757 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 758 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 759 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 760 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 761 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 762 java.lang.Boolean iconImage, byte[] iconBytes, 763 com.liferay.portal.service.ServiceContext serviceContext) 764 throws com.liferay.portal.kernel.exception.PortalException, 765 com.liferay.portal.kernel.exception.SystemException { 766 return _layoutService.updateLayout(groupId, privateLayout, layoutId, 767 parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap, 768 keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage, 769 iconBytes, serviceContext); 770 } 771 772 /** 773 * Updates the layout replacing its type settings. 774 * 775 * @param groupId the primary key of the group 776 * @param privateLayout whether the layout is private to the group 777 * @param layoutId the primary key of the layout 778 * @param typeSettings the settings to load the unicode properties object. 779 See {@link com.liferay.portal.kernel.util.UnicodeProperties 780 #fastLoad(String)}. 781 * @return the updated layout 782 * @throws PortalException if a matching layout could not be found or if the 783 user did not have permission to update the layout 784 * @throws SystemException if a system exception occurred 785 */ 786 public com.liferay.portal.model.Layout updateLayout(long groupId, 787 boolean privateLayout, long layoutId, java.lang.String typeSettings) 788 throws com.liferay.portal.kernel.exception.PortalException, 789 com.liferay.portal.kernel.exception.SystemException { 790 return _layoutService.updateLayout(groupId, privateLayout, layoutId, 791 typeSettings); 792 } 793 794 /** 795 * Updates the look and feel of the layout. 796 * 797 * @param groupId the primary key of the group 798 * @param privateLayout whether the layout is private to the group 799 * @param layoutId the primary key of the layout 800 * @param themeId the primary key of the layout's new theme 801 * @param colorSchemeId the primary key of the layout's new color scheme 802 * @param css the layout's new CSS 803 * @param wapTheme whether the theme is for WAP browsers 804 * @return the updated layout 805 * @throws PortalException if a matching layout could not be found, or if 806 the user did not have permission to update the layout and 807 permission to apply the theme 808 * @throws SystemException if a system exception occurred 809 */ 810 public com.liferay.portal.model.Layout updateLookAndFeel(long groupId, 811 boolean privateLayout, long layoutId, java.lang.String themeId, 812 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 813 throws com.liferay.portal.kernel.exception.PortalException, 814 com.liferay.portal.kernel.exception.SystemException { 815 return _layoutService.updateLookAndFeel(groupId, privateLayout, 816 layoutId, themeId, colorSchemeId, css, wapTheme); 817 } 818 819 /** 820 * Updates the name of the layout matching the group, layout ID, and 821 * privacy. 822 * 823 * @param groupId the primary key of the group 824 * @param privateLayout whether the layout is private to the group 825 * @param layoutId the primary key of the layout 826 * @param name the layout's new name 827 * @param languageId the primary key of the language. For more information 828 see {@link java.util.Locale}. 829 * @return the updated layout 830 * @throws PortalException if a matching layout could not be found, if the 831 user did not have permission to update the layout, or if the new 832 name was <code>null</code> 833 * @throws SystemException if a system exception occurred 834 */ 835 public com.liferay.portal.model.Layout updateName(long groupId, 836 boolean privateLayout, long layoutId, java.lang.String name, 837 java.lang.String languageId) 838 throws com.liferay.portal.kernel.exception.PortalException, 839 com.liferay.portal.kernel.exception.SystemException { 840 return _layoutService.updateName(groupId, privateLayout, layoutId, 841 name, languageId); 842 } 843 844 /** 845 * Updates the name of the layout matching the primary key. 846 * 847 * @param plid the primary key of the layout 848 * @param name the name to be assigned 849 * @param languageId the primary key of the language. For more information 850 see {@link java.util.Locale}. 851 * @return the updated layout 852 * @throws PortalException if a layout with the primary key could not be 853 found, or if the user did not have permission to update the 854 layout, or if the name was <code>null</code> 855 * @throws SystemException if a system exception occurred 856 */ 857 public com.liferay.portal.model.Layout updateName(long plid, 858 java.lang.String name, java.lang.String languageId) 859 throws com.liferay.portal.kernel.exception.PortalException, 860 com.liferay.portal.kernel.exception.SystemException { 861 return _layoutService.updateName(plid, name, languageId); 862 } 863 864 /** 865 * Updates the parent layout ID of the layout matching the group, layout ID, 866 * and privacy. 867 * 868 * @param groupId the primary key of the group 869 * @param privateLayout whether the layout is private to the group 870 * @param layoutId the primary key of the layout 871 * @param parentLayoutId the primary key to be assigned to the parent 872 layout 873 * @return the matching layout 874 * @throws PortalException if a valid parent layout ID to use could not be 875 found, if a matching layout could not be found, or if the user 876 did not have permission to update the layout 877 * @throws SystemException if a system exception occurred 878 */ 879 public com.liferay.portal.model.Layout updateParentLayoutId(long groupId, 880 boolean privateLayout, long layoutId, long parentLayoutId) 881 throws com.liferay.portal.kernel.exception.PortalException, 882 com.liferay.portal.kernel.exception.SystemException { 883 return _layoutService.updateParentLayoutId(groupId, privateLayout, 884 layoutId, parentLayoutId); 885 } 886 887 /** 888 * Updates the parent layout ID of the layout matching the primary key. If a 889 * layout matching the parent primary key is found, the layout ID of that 890 * layout is assigned, otherwise {@link 891 * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is 892 * assigned. 893 * 894 * @param plid the primary key of the layout 895 * @param parentPlid the primary key of the parent layout 896 * @return the layout matching the primary key 897 * @throws PortalException if a layout with the primary key could not be 898 found, if the user did not have permission to update the layout, 899 or if a valid parent layout ID to use could not be found 900 * @throws SystemException if a system exception occurred 901 */ 902 public com.liferay.portal.model.Layout updateParentLayoutId(long plid, 903 long parentPlid) 904 throws com.liferay.portal.kernel.exception.PortalException, 905 com.liferay.portal.kernel.exception.SystemException { 906 return _layoutService.updateParentLayoutId(plid, parentPlid); 907 } 908 909 /** 910 * Updates the priority of the layout matching the group, layout ID, and 911 * privacy. 912 * 913 * @param groupId the primary key of the group 914 * @param privateLayout whether the layout is private to the group 915 * @param layoutId the primary key of the layout 916 * @param priority the layout's new priority 917 * @return the updated layout 918 * @throws PortalException if a matching layout could not be found or if the 919 user did not have permission to update the layout 920 * @throws SystemException if a system exception occurred 921 */ 922 public com.liferay.portal.model.Layout updatePriority(long groupId, 923 boolean privateLayout, long layoutId, int priority) 924 throws com.liferay.portal.kernel.exception.PortalException, 925 com.liferay.portal.kernel.exception.SystemException { 926 return _layoutService.updatePriority(groupId, privateLayout, layoutId, 927 priority); 928 } 929 930 /** 931 * Updates the priority of the layout matching the primary key. 932 * 933 * @param plid the primary key of the layout 934 * @param priority the layout's new priority 935 * @return the updated layout 936 * @throws PortalException if a layout with the primary key could not be 937 found 938 * @throws SystemException if a system exception occurred 939 */ 940 public com.liferay.portal.model.Layout updatePriority(long plid, 941 int priority) 942 throws com.liferay.portal.kernel.exception.PortalException, 943 com.liferay.portal.kernel.exception.SystemException { 944 return _layoutService.updatePriority(plid, priority); 945 } 946 947 /** 948 * @deprecated Renamed to {@link #getWrappedService} 949 */ 950 public LayoutService getWrappedLayoutService() { 951 return _layoutService; 952 } 953 954 /** 955 * @deprecated Renamed to {@link #setWrappedService} 956 */ 957 public void setWrappedLayoutService(LayoutService layoutService) { 958 _layoutService = layoutService; 959 } 960 961 public LayoutService getWrappedService() { 962 return _layoutService; 963 } 964 965 public void setWrappedService(LayoutService layoutService) { 966 _layoutService = layoutService; 967 } 968 969 private LayoutService _layoutService; 970 }