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