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