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