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