001 /** 002 * Copyright (c) 2000-present 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 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the remote service utility for Layout. This utility wraps 024 * {@link com.liferay.portal.service.impl.LayoutServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on a remote server. Methods of this service are expected to have security 027 * checks based on the propagated JAAS credentials because this service can be 028 * accessed remotely. 029 * 030 * @author Brian Wing Shun Chan 031 * @see LayoutService 032 * @see com.liferay.portal.service.base.LayoutServiceBaseImpl 033 * @see com.liferay.portal.service.impl.LayoutServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class LayoutServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds a layout with additional parameters. 046 * 047 * <p> 048 * This method handles the creation of the layout including its resources, 049 * metadata, and internal data structures. It is not necessary to make 050 * subsequent calls to any methods to setup default groups, resources, ... 051 * etc. 052 * </p> 053 * 054 * @param groupId the primary key of the group 055 * @param privateLayout whether the layout is private to the group 056 * @param parentLayoutId the primary key of the parent layout 057 (optionally {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 058 * @param localeNamesMap the layout's locales and localized names 059 * @param localeTitlesMap the layout's locales and localized titles 060 * @param descriptionMap the layout's locales and localized 061 descriptions 062 * @param keywordsMap the layout's locales and localized keywords 063 * @param robotsMap the layout's locales and localized robots 064 * @param type the layout's type (optionally {@link 065 LayoutConstants#TYPE_PORTLET}). The possible types can be 066 found in {@link LayoutConstants}. 067 * @param hidden whether the layout is hidden 068 * @param friendlyURL the layout's locales and localized friendly URLs. 069 To see how the URL is normalized when accessed, see {@link 070 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 071 String)}. 072 * @param serviceContext the service context to be applied. Must set 073 the UUID for the layout. Can set the creation date, 074 modification date, and expando bridge attributes for the 075 layout. For layouts that belong to a layout set prototype, an 076 attribute named <code>layoutUpdateable</code> can be used to 077 specify whether site administrators can modify this page 078 within their site. 079 * @return the layout 080 * @throws PortalException if a group with the primary key could not be 081 found, if the group did not have permission to manage the 082 layouts involved, if layout values were invalid, or if a 083 portal exception occurred 084 * @deprecated As of 6.2.0, replaced by {@link #addLayout(long, boolean, 085 long, Map, Map, Map, Map, Map, String, String, boolean, Map, 086 ServiceContext)} 087 */ 088 @Deprecated 089 public static com.liferay.portal.model.Layout addLayout(long groupId, 090 boolean privateLayout, long parentLayoutId, 091 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 092 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 093 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 094 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 095 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 096 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 097 com.liferay.portal.service.ServiceContext serviceContext) 098 throws com.liferay.portal.kernel.exception.PortalException { 099 return getService() 100 .addLayout(groupId, privateLayout, parentLayoutId, 101 localeNamesMap, localeTitlesMap, descriptionMap, keywordsMap, 102 robotsMap, type, hidden, friendlyURL, serviceContext); 103 } 104 105 /** 106 * Adds a layout with additional parameters. 107 * 108 * <p> 109 * This method handles the creation of the layout including its resources, 110 * metadata, and internal data structures. It is not necessary to make 111 * subsequent calls to any methods to setup default groups, resources, ... 112 * etc. 113 * </p> 114 * 115 * @param groupId the primary key of the group 116 * @param privateLayout whether the layout is private to the group 117 * @param parentLayoutId the primary key of the parent layout (optionally 118 {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 119 * @param localeNamesMap the layout's locales and localized names 120 * @param localeTitlesMap the layout's locales and localized titles 121 * @param descriptionMap the layout's locales and localized descriptions 122 * @param keywordsMap the layout's locales and localized keywords 123 * @param robotsMap the layout's locales and localized robots 124 * @param type the layout's type (optionally {@link 125 LayoutConstants#TYPE_PORTLET}). The possible types can be found 126 in {@link LayoutConstants}. 127 * @param typeSettings the settings to load the unicode properties object. 128 See {@link com.liferay.portal.kernel.util.UnicodeProperties 129 #fastLoad(String)}. 130 * @param hidden whether the layout is hidden 131 * @param friendlyURLMap the layout's locales and localized friendly URLs. 132 To see how the URL is normalized when accessed, see {@link 133 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 134 String)}. 135 * @param serviceContext the service context to be applied. Must set the 136 UUID for the layout. Can set the creation date, modification 137 date, and expando bridge attributes for the layout. For layouts 138 that belong to a layout set prototype, an attribute named 139 <code>layoutUpdateable</code> can be used to specify whether site 140 administrators can modify this page within their site. 141 * @return the layout 142 * @throws PortalException if a group with the primary key could not be 143 found, if the group did not have permission to manage the layouts 144 involved, if layout values were invalid, or if a portal exception 145 occurred 146 */ 147 public static com.liferay.portal.model.Layout addLayout(long groupId, 148 boolean privateLayout, long parentLayoutId, 149 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 150 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 151 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 152 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 153 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 154 java.lang.String type, java.lang.String typeSettings, boolean hidden, 155 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 156 com.liferay.portal.service.ServiceContext serviceContext) 157 throws com.liferay.portal.kernel.exception.PortalException { 158 return getService() 159 .addLayout(groupId, privateLayout, parentLayoutId, 160 localeNamesMap, localeTitlesMap, descriptionMap, keywordsMap, 161 robotsMap, type, typeSettings, hidden, friendlyURLMap, 162 serviceContext); 163 } 164 165 /** 166 * Adds a layout with single entry maps for name, title, and description to 167 * the default locale. 168 * 169 * <p> 170 * This method handles the creation of the layout including its resources, 171 * metadata, and internal data structures. It is not necessary to make 172 * subsequent calls to any methods to setup default groups, resources, ... 173 * etc. 174 * </p> 175 * 176 * @param groupId the primary key of the group 177 * @param privateLayout whether the layout is private to the group 178 * @param parentLayoutId the primary key of the parent layout (optionally 179 {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 180 * @param name the layout's locales and localized names 181 * @param title the layout's locales and localized titles 182 * @param description the layout's locales and localized descriptions 183 * @param type the layout's type (optionally {@link 184 LayoutConstants#TYPE_PORTLET}). The possible types can be found 185 in {@link LayoutConstants}. 186 * @param hidden whether the layout is hidden 187 * @param friendlyURL the layout's locales and localized friendly URLs. To 188 see how the URL is normalized when accessed, see {@link 189 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 190 String)}. 191 * @param serviceContext the service context to be applied. Must set the 192 UUID for the layout. Can specify the creation date, modification 193 date, and expando bridge attributes for the layout. For layouts 194 that belong to a layout set prototype, an attribute named 195 <code>layoutUpdateable</code> can be used to specify whether site 196 administrators can modify this page within their site. 197 * @return the layout 198 * @throws PortalException if a group with the primary key could not be 199 found, if the group did not have permission to manage the layouts 200 involved, if layout values were invalid, or if a portal exception 201 occurred 202 */ 203 public static com.liferay.portal.model.Layout addLayout(long groupId, 204 boolean privateLayout, long parentLayoutId, java.lang.String name, 205 java.lang.String title, java.lang.String description, 206 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 207 com.liferay.portal.service.ServiceContext serviceContext) 208 throws com.liferay.portal.kernel.exception.PortalException { 209 return getService() 210 .addLayout(groupId, privateLayout, parentLayoutId, name, 211 title, description, type, hidden, friendlyURL, serviceContext); 212 } 213 214 public static com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry( 215 long groupId, java.lang.String folderName, java.lang.String fileName, 216 java.io.InputStream inputStream, java.lang.String mimeType) 217 throws com.liferay.portal.kernel.exception.PortalException { 218 return getService() 219 .addTempFileEntry(groupId, folderName, fileName, 220 inputStream, mimeType); 221 } 222 223 /** 224 * Deletes the layout with the primary key, also deleting the layout's child 225 * layouts, and associated resources. 226 * 227 * @param groupId the primary key of the group 228 * @param privateLayout whether the layout is private to the group 229 * @param layoutId the primary key of the layout 230 * @param serviceContext the service context to be applied 231 * @throws PortalException if the user did not have permission to delete the 232 layout, if a matching layout could not be found , or if some 233 other portal exception occurred 234 */ 235 public static void deleteLayout(long groupId, boolean privateLayout, 236 long layoutId, com.liferay.portal.service.ServiceContext serviceContext) 237 throws com.liferay.portal.kernel.exception.PortalException { 238 getService() 239 .deleteLayout(groupId, privateLayout, layoutId, serviceContext); 240 } 241 242 /** 243 * Deletes the layout with the plid, also deleting the layout's child 244 * layouts, and associated resources. 245 * 246 * @param plid the primary key of the layout 247 * @param serviceContext the service context to be applied 248 * @throws PortalException if the user did not have permission to delete the 249 layout, if a layout with the primary key could not be found , or 250 if some other portal exception occurred 251 */ 252 public static void deleteLayout(long plid, 253 com.liferay.portal.service.ServiceContext serviceContext) 254 throws com.liferay.portal.kernel.exception.PortalException { 255 getService().deleteLayout(plid, serviceContext); 256 } 257 258 public static void deleteTempFileEntry(long groupId, 259 java.lang.String folderName, java.lang.String fileName) 260 throws com.liferay.portal.kernel.exception.PortalException { 261 getService().deleteTempFileEntry(groupId, folderName, fileName); 262 } 263 264 /** 265 * Exports the layouts that match the primary keys and the criteria as a 266 * byte array. 267 * 268 * @param groupId the primary key of the group 269 * @param privateLayout whether the layout is private to the group 270 * @param layoutIds the primary keys of the layouts to be exported 271 * @param parameterMap the mapping of parameters indicating which 272 information to export. For information on the keys used in 273 the map see {@link 274 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 275 * @param startDate the export's start date 276 * @param endDate the export's end date 277 * @return the layouts as a byte array 278 * @throws PortalException if a group or any layout with the primary key 279 could not be found, if the group did not have permission to 280 manage the layouts, or if some other portal exception 281 occurred 282 * @deprecated As of 7.0.0, with no direct replacement 283 */ 284 @Deprecated 285 public static byte[] exportLayouts(long groupId, boolean privateLayout, 286 long[] layoutIds, 287 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 288 java.util.Date startDate, java.util.Date endDate) 289 throws com.liferay.portal.kernel.exception.PortalException { 290 return getService() 291 .exportLayouts(groupId, privateLayout, layoutIds, 292 parameterMap, startDate, endDate); 293 } 294 295 /** 296 * Exports all layouts that match the criteria as a byte array. 297 * 298 * @param groupId the primary key of the group 299 * @param privateLayout whether the layout is private to the group 300 * @param parameterMap the mapping of parameters indicating which 301 information to export. For information on the keys used in 302 the map see {@link 303 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 304 * @param startDate the export's start date 305 * @param endDate the export's end date 306 * @return the layout as a byte array 307 * @throws PortalException if a group with the primary key could not be 308 found, if the group did not have permission to manage the 309 layouts, or if some other portal exception occurred 310 * @deprecated As of 7.0.0, with no direct replacement 311 */ 312 @Deprecated 313 public static byte[] exportLayouts(long groupId, boolean privateLayout, 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 return getService() 318 .exportLayouts(groupId, privateLayout, parameterMap, 319 startDate, endDate); 320 } 321 322 /** 323 * @deprecated As of 7.0.0, replaced by {@link 324 com.liferay.portlet.exportimport.service.ExportImportService#exportLayoutsAsFile( 325 ExportImportConfiguration)} 326 */ 327 @Deprecated 328 public static java.io.File exportLayoutsAsFile( 329 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 330 throws com.liferay.portal.kernel.exception.PortalException { 331 return getService().exportLayoutsAsFile(exportImportConfiguration); 332 } 333 334 /** 335 * Exports all layouts that match the primary keys and criteria as a file. 336 * 337 * @param groupId the primary key of the group 338 * @param privateLayout whether the layout is private to the group 339 * @param layoutIds the primary keys of the layouts to be exported 340 (optionally <code>null</code>) 341 * @param parameterMap the mapping of parameters indicating which 342 information to export. For information on the keys used in 343 the map see {@link 344 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 345 * @param startDate the export's start date 346 * @param endDate the export's end date 347 * @return the layouts as a File 348 * @throws PortalException if a group or any layout with the primary key 349 could not be found, it the group did not have permission to 350 manage the layouts, or if some other portal exception 351 occurred 352 * @deprecated As of 7.0.0, with no direct replacement 353 */ 354 @Deprecated 355 public static java.io.File exportLayoutsAsFile(long groupId, 356 boolean privateLayout, long[] layoutIds, 357 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 358 java.util.Date startDate, java.util.Date endDate) 359 throws com.liferay.portal.kernel.exception.PortalException { 360 return getService() 361 .exportLayoutsAsFile(groupId, privateLayout, layoutIds, 362 parameterMap, startDate, endDate); 363 } 364 365 /** 366 * @deprecated As of 7.0.0, replaced by {@link 367 com.liferay.portlet.exportimport.service.ExportImportService#exportLayoutsAsFileInBackground( 368 ExportImportConfiguration)} 369 */ 370 @Deprecated 371 public static long exportLayoutsAsFileInBackground( 372 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 373 throws com.liferay.portal.kernel.exception.PortalException { 374 return getService() 375 .exportLayoutsAsFileInBackground(exportImportConfiguration); 376 } 377 378 /** 379 * @deprecated As of 7.0.0, replaced by {@link 380 com.liferay.portlet.exportimport.service.ExportImportService#exportLayoutsAsFileInBackground( 381 long)} 382 */ 383 @Deprecated 384 public static long exportLayoutsAsFileInBackground( 385 long exportImportConfigurationId) 386 throws com.liferay.portal.kernel.exception.PortalException { 387 return getService() 388 .exportLayoutsAsFileInBackground(exportImportConfigurationId); 389 } 390 391 /** 392 * @deprecated As of 7.0.0, with no direct replacement 393 */ 394 @Deprecated 395 public static long exportLayoutsAsFileInBackground( 396 java.lang.String taskName, long groupId, boolean privateLayout, 397 long[] layoutIds, 398 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 399 java.util.Date startDate, java.util.Date endDate) 400 throws com.liferay.portal.kernel.exception.PortalException { 401 return getService() 402 .exportLayoutsAsFileInBackground(taskName, groupId, 403 privateLayout, layoutIds, parameterMap, startDate, endDate); 404 } 405 406 /** 407 * @deprecated As of 7.0.0, with no direct replacement 408 */ 409 @Deprecated 410 public static long exportLayoutsAsFileInBackground( 411 java.lang.String taskName, long groupId, boolean privateLayout, 412 long[] layoutIds, 413 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 414 java.util.Date startDate, java.util.Date endDate, 415 java.lang.String fileName) 416 throws com.liferay.portal.kernel.exception.PortalException { 417 return getService() 418 .exportLayoutsAsFileInBackground(taskName, groupId, 419 privateLayout, layoutIds, parameterMap, startDate, endDate, fileName); 420 } 421 422 /** 423 * @deprecated As of 7.0.0, with no direct replacement 424 */ 425 @Deprecated 426 public static byte[] exportPortletInfo(long companyId, 427 java.lang.String portletId, 428 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 429 java.util.Date startDate, java.util.Date endDate) 430 throws com.liferay.portal.kernel.exception.PortalException { 431 return getService() 432 .exportPortletInfo(companyId, portletId, parameterMap, 433 startDate, endDate); 434 } 435 436 /** 437 * Exports the portlet information (categories, permissions, ... etc.) as a 438 * byte array. 439 * 440 * @param plid the primary key of the layout 441 * @param groupId the primary key of the group 442 * @param portletId the primary key of the portlet 443 * @param parameterMap the mapping of parameters indicating which 444 information to export. For information on the keys used in 445 the map see {@link 446 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 447 * @param startDate the export's start date 448 * @param endDate the export's end date 449 * @return the portlet information as a byte array 450 * @throws PortalException if a layout, group, or portlet with the 451 primary key could not be found, if the group did not have 452 permission to manage the layouts involved, or if some other 453 portal exception occurred 454 * @deprecated As of 7.0.0, with no direct replacement 455 */ 456 @Deprecated 457 public static byte[] exportPortletInfo(long plid, long groupId, 458 java.lang.String portletId, 459 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 460 java.util.Date startDate, java.util.Date endDate) 461 throws com.liferay.portal.kernel.exception.PortalException { 462 return getService() 463 .exportPortletInfo(plid, groupId, portletId, parameterMap, 464 startDate, endDate); 465 } 466 467 /** 468 * @deprecated As of 7.0.0, replaced by {@link 469 com.liferay.portlet.exportimport.service.ExportImportService#exportPortletInfoAsFile( 470 ExportImportConfiguration)} 471 */ 472 @Deprecated 473 public static java.io.File exportPortletInfoAsFile( 474 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 475 throws com.liferay.portal.kernel.exception.PortalException { 476 return getService().exportPortletInfoAsFile(exportImportConfiguration); 477 } 478 479 /** 480 * Exports the portlet information (categories, permissions, ... etc.) as a 481 * file. 482 * 483 * @param plid the primary key of the layout 484 * @param groupId the primary key of the group 485 * @param portletId the primary key of the portlet 486 * @param parameterMap the mapping of parameters indicating which 487 information to export. For information on the keys used in 488 the map see {@link 489 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 490 * @param startDate the export's start date 491 * @param endDate the export's end date 492 * @return the portlet information as a file 493 * @throws PortalException if a layout, group, or portlet with the 494 primary key could not be found, it the group did not have 495 permission to manage the layouts involved, or if some other 496 portal exception occurred 497 * @deprecated As of 7.0.0, with no direct replacement 498 */ 499 @Deprecated 500 public static java.io.File exportPortletInfoAsFile(long plid, long groupId, 501 java.lang.String portletId, 502 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 503 java.util.Date startDate, java.util.Date endDate) 504 throws com.liferay.portal.kernel.exception.PortalException { 505 return getService() 506 .exportPortletInfoAsFile(plid, groupId, portletId, 507 parameterMap, startDate, endDate); 508 } 509 510 /** 511 * @deprecated As of 7.0.0, with no direct replacement 512 */ 513 @Deprecated 514 public static java.io.File exportPortletInfoAsFile( 515 java.lang.String portletId, 516 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 517 java.util.Date startDate, java.util.Date endDate) 518 throws com.liferay.portal.kernel.exception.PortalException { 519 return getService() 520 .exportPortletInfoAsFile(portletId, parameterMap, startDate, 521 endDate); 522 } 523 524 /** 525 * @deprecated As of 7.0.0, with no direct replacement 526 */ 527 @Deprecated 528 public static long exportPortletInfoAsFileInBackground( 529 java.lang.String taskName, long plid, long groupId, 530 java.lang.String portletId, 531 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 532 java.util.Date startDate, java.util.Date endDate, 533 java.lang.String fileName) 534 throws com.liferay.portal.kernel.exception.PortalException { 535 return getService() 536 .exportPortletInfoAsFileInBackground(taskName, plid, 537 groupId, portletId, parameterMap, startDate, endDate, fileName); 538 } 539 540 /** 541 * @deprecated As of 7.0.0, with no direct replacement 542 */ 543 @Deprecated 544 public static long exportPortletInfoAsFileInBackground( 545 java.lang.String taskName, java.lang.String portletId, 546 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 547 java.util.Date startDate, java.util.Date endDate, 548 java.lang.String fileName) 549 throws com.liferay.portal.kernel.exception.PortalException { 550 return getService() 551 .exportPortletInfoAsFileInBackground(taskName, portletId, 552 parameterMap, startDate, endDate, fileName); 553 } 554 555 /** 556 * Returns all the ancestor layouts of the layout. 557 * 558 * @param plid the primary key of the layout 559 * @return the ancestor layouts of the layout 560 * @throws PortalException if a matching layout could not be found or if a 561 portal exception occurred 562 */ 563 public static java.util.List<com.liferay.portal.model.Layout> getAncestorLayouts( 564 long plid) throws com.liferay.portal.kernel.exception.PortalException { 565 return getService().getAncestorLayouts(plid); 566 } 567 568 /** 569 * Returns the Spring bean ID for this bean. 570 * 571 * @return the Spring bean ID for this bean 572 */ 573 public static java.lang.String getBeanIdentifier() { 574 return getService().getBeanIdentifier(); 575 } 576 577 public static long getDefaultPlid(long groupId, long scopeGroupId, 578 java.lang.String portletId) 579 throws com.liferay.portal.kernel.exception.PortalException { 580 return getService().getDefaultPlid(groupId, scopeGroupId, portletId); 581 } 582 583 /** 584 * Returns the primary key of the default layout for the group. 585 * 586 * @param groupId the primary key of the group 587 * @param scopeGroupId the primary key of the scope group. See {@link 588 ServiceContext#getScopeGroupId()}. 589 * @param privateLayout whether the layout is private to the group 590 * @param portletId the primary key of the portlet 591 * @return Returns the primary key of the default layout group; {@link 592 LayoutConstants#DEFAULT_PLID} otherwise 593 * @throws PortalException if a group, layout, or portlet with the primary 594 key could not be found 595 */ 596 public static long getDefaultPlid(long groupId, long scopeGroupId, 597 boolean privateLayout, java.lang.String portletId) 598 throws com.liferay.portal.kernel.exception.PortalException { 599 return getService() 600 .getDefaultPlid(groupId, scopeGroupId, privateLayout, 601 portletId); 602 } 603 604 /** 605 * Returns the layout matching the UUID, group, and privacy. 606 * 607 * @param uuid the layout's UUID 608 * @param groupId the primary key of the group 609 * @param privateLayout whether the layout is private to the group 610 * @return the matching layout 611 * @throws PortalException if a matching layout could not be found, if the 612 user did not have permission to view the layout, or if some other 613 portal exception occurred 614 */ 615 public static com.liferay.portal.model.Layout getLayoutByUuidAndGroupId( 616 java.lang.String uuid, long groupId, boolean privateLayout) 617 throws com.liferay.portal.kernel.exception.PortalException { 618 return getService() 619 .getLayoutByUuidAndGroupId(uuid, groupId, privateLayout); 620 } 621 622 /** 623 * Returns the name of the layout. 624 * 625 * @param groupId the primary key of the group 626 * @param privateLayout whether the layout is private to the group 627 * @param layoutId the primary key of the layout 628 * @param languageId the primary key of the language. For more information 629 See {@link Locale}. 630 * @return the layout's name 631 * @throws PortalException if a matching layout could not be found 632 */ 633 public static java.lang.String getLayoutName(long groupId, 634 boolean privateLayout, long layoutId, java.lang.String languageId) 635 throws com.liferay.portal.kernel.exception.PortalException { 636 return getService() 637 .getLayoutName(groupId, privateLayout, layoutId, languageId); 638 } 639 640 /** 641 * Returns the layout references for all the layouts that belong to the 642 * company and belong to the portlet that matches the preferences. 643 * 644 * @param companyId the primary key of the company 645 * @param portletId the primary key of the portlet 646 * @param preferencesKey the portlet's preference key 647 * @param preferencesValue the portlet's preference value 648 * @return the layout references of the matching layouts 649 */ 650 public static com.liferay.portal.model.LayoutReference[] getLayoutReferences( 651 long companyId, java.lang.String portletId, 652 java.lang.String preferencesKey, java.lang.String preferencesValue) { 653 return getService() 654 .getLayoutReferences(companyId, portletId, preferencesKey, 655 preferencesValue); 656 } 657 658 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 659 long groupId, boolean privateLayout) { 660 return getService().getLayouts(groupId, privateLayout); 661 } 662 663 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 664 long groupId, boolean privateLayout, long parentLayoutId) { 665 return getService().getLayouts(groupId, privateLayout, parentLayoutId); 666 } 667 668 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 669 long groupId, boolean privateLayout, long parentLayoutId, 670 boolean incomplete, int start, int end) 671 throws com.liferay.portal.kernel.exception.PortalException { 672 return getService() 673 .getLayouts(groupId, privateLayout, parentLayoutId, 674 incomplete, start, end); 675 } 676 677 public static int getLayoutsCount(long groupId, boolean privateLayout, 678 long parentLayoutId) { 679 return getService() 680 .getLayoutsCount(groupId, privateLayout, parentLayoutId); 681 } 682 683 public static java.lang.String[] getTempFileNames(long groupId, 684 java.lang.String folderName) 685 throws com.liferay.portal.kernel.exception.PortalException { 686 return getService().getTempFileNames(groupId, folderName); 687 } 688 689 /** 690 * @deprecated As of 7.0.0, replaced by {@link 691 com.liferay.portlet.exportimport.service.ExportImportService#importLayouts( 692 ExportImportConfiguration, File)} 693 */ 694 @Deprecated 695 public static void importLayouts( 696 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 697 java.io.File file) 698 throws com.liferay.portal.kernel.exception.PortalException { 699 getService().importLayouts(exportImportConfiguration, file); 700 } 701 702 /** 703 * @deprecated As of 7.0.0, replaced by {@link 704 com.liferay.portlet.exportimport.service.ExportImportService#importLayouts( 705 ExportImportConfiguration, InputStream)} 706 */ 707 @Deprecated 708 public static void importLayouts( 709 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 710 java.io.InputStream is) 711 throws com.liferay.portal.kernel.exception.PortalException { 712 getService().importLayouts(exportImportConfiguration, is); 713 } 714 715 /** 716 * Imports the layouts from the byte array. 717 * 718 * @param groupId the primary key of the group 719 * @param privateLayout whether the layout is private to the group 720 * @param parameterMap the mapping of parameters indicating which 721 information will be imported. For information on the keys 722 used in the map see {@link 723 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 724 * @param bytes the byte array with the data 725 * @throws PortalException if a group with the primary key could not be 726 found, if the group did not have permission to manage the 727 layouts, or if some other portal exception occurred 728 * @see com.liferay.portlet.exportimport.lar.LayoutImporter 729 * @deprecated As of 7.0.0, with no direct replacement 730 */ 731 @Deprecated 732 public static void importLayouts(long groupId, boolean privateLayout, 733 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 734 byte[] bytes) 735 throws com.liferay.portal.kernel.exception.PortalException { 736 getService().importLayouts(groupId, privateLayout, parameterMap, bytes); 737 } 738 739 /** 740 * Imports the layouts from the file. 741 * 742 * @param groupId the primary key of the group 743 * @param privateLayout whether the layout is private to the group 744 * @param parameterMap the mapping of parameters indicating which 745 information will be imported. For information on the keys 746 used in the map see {@link 747 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 748 * @param file the LAR file with the data 749 * @throws PortalException if a group with the primary key could not be 750 found, if the group did not have permission to manage the 751 layouts and publish, or if some other portal exception 752 occurred 753 * @see com.liferay.portlet.exportimport.lar.LayoutImporter 754 * @deprecated As of 7.0.0, with no direct replacement 755 */ 756 @Deprecated 757 public static void importLayouts(long groupId, boolean privateLayout, 758 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 759 java.io.File file) 760 throws com.liferay.portal.kernel.exception.PortalException { 761 getService().importLayouts(groupId, privateLayout, parameterMap, file); 762 } 763 764 /** 765 * Imports the layouts from the input stream. 766 * 767 * @param groupId the primary key of the group 768 * @param privateLayout whether the layout is private to the group 769 * @param parameterMap the mapping of parameters indicating which 770 information will be imported. For information on the keys 771 used in the map see {@link 772 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 773 * @param is the input stream 774 * @throws PortalException if a group with the primary key could not be 775 found, if the group did not have permission to manage the 776 layouts, or if some other portal exception occurred 777 * @see com.liferay.portlet.exportimport.lar.LayoutImporter 778 * @deprecated As of 7.0.0, with no direct replacement 779 */ 780 @Deprecated 781 public static void importLayouts(long groupId, boolean privateLayout, 782 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 783 java.io.InputStream is) 784 throws com.liferay.portal.kernel.exception.PortalException { 785 getService().importLayouts(groupId, privateLayout, parameterMap, is); 786 } 787 788 /** 789 * @deprecated As of 7.0.0, with no direct replacement 790 */ 791 @Deprecated 792 public static long importLayoutsInBackground(java.lang.String taskName, 793 long groupId, boolean privateLayout, 794 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 795 java.io.File file) 796 throws com.liferay.portal.kernel.exception.PortalException { 797 return getService() 798 .importLayoutsInBackground(taskName, groupId, privateLayout, 799 parameterMap, file); 800 } 801 802 /** 803 * @deprecated As of 7.0.0, with no direct replacement 804 */ 805 @Deprecated 806 public static long importLayoutsInBackground(java.lang.String taskName, 807 long groupId, boolean privateLayout, 808 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 809 java.io.InputStream inputStream) 810 throws com.liferay.portal.kernel.exception.PortalException { 811 return getService() 812 .importLayoutsInBackground(taskName, groupId, privateLayout, 813 parameterMap, inputStream); 814 } 815 816 /** 817 * @deprecated As of 7.0.0, replaced by {@link 818 com.liferay.portlet.exportimport.service.ExportImportService#importPortletInfo( 819 ExportImportConfiguration, File)} ( 820 */ 821 @Deprecated 822 public static void importPortletInfo( 823 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 824 java.io.File file) 825 throws com.liferay.portal.kernel.exception.PortalException { 826 getService().importPortletInfo(exportImportConfiguration, file); 827 } 828 829 /** 830 * @deprecated As of 7.0.0, replaced by {@link 831 com.liferay.portlet.exportimport.service.ExportImportService#importPortletInfo( 832 ExportImportConfiguration, InputStream)} ( 833 */ 834 @Deprecated 835 public static void importPortletInfo( 836 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 837 java.io.InputStream is) 838 throws com.liferay.portal.kernel.exception.PortalException { 839 getService().importPortletInfo(exportImportConfiguration, is); 840 } 841 842 /** 843 * Imports the portlet information (categories, permissions, ... etc.) from 844 * the file. 845 * 846 * @param plid the primary key of the layout 847 * @param groupId the primary key of the group 848 * @param portletId the primary key of the portlet 849 * @param parameterMap the mapping of parameters indicating which 850 information will be imported. For information on the keys 851 used in the map see {@link 852 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 853 * @param file the LAR file with the data 854 * @throws PortalException if a group, layout, or portlet with the 855 primary key could not be found, or if the group did not have 856 permission to manage the layouts 857 * @deprecated As of 7.0.0, with no direct replacement 858 */ 859 @Deprecated 860 public static void importPortletInfo(long plid, long groupId, 861 java.lang.String portletId, 862 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 863 java.io.File file) 864 throws com.liferay.portal.kernel.exception.PortalException { 865 getService() 866 .importPortletInfo(plid, groupId, portletId, parameterMap, file); 867 } 868 869 /** 870 * Imports the portlet information (categories, permissions, ... etc.) from 871 * the input stream. 872 * 873 * @param plid the primary key of the layout 874 * @param groupId the primary key of the group 875 * @param portletId the primary key of the portlet 876 * @param parameterMap the mapping of parameters indicating which 877 information will be imported. For information on the keys 878 used in the map see {@link 879 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 880 * @param is the input stream 881 * @throws PortalException if a group, portlet, or layout with the 882 primary key could not be found or if the group did not have 883 permission to manage the layouts 884 * @deprecated As of 7.0.0, with no direct replacement 885 */ 886 @Deprecated 887 public static void importPortletInfo(long plid, long groupId, 888 java.lang.String portletId, 889 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 890 java.io.InputStream is) 891 throws com.liferay.portal.kernel.exception.PortalException { 892 getService() 893 .importPortletInfo(plid, groupId, portletId, parameterMap, is); 894 } 895 896 /** 897 * @deprecated As of 7.0.0, with no direct replacement 898 */ 899 @Deprecated 900 public static void importPortletInfo(java.lang.String portletId, 901 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 902 java.io.File file) 903 throws com.liferay.portal.kernel.exception.PortalException { 904 getService().importPortletInfo(portletId, parameterMap, file); 905 } 906 907 /** 908 * @deprecated As of 7.0.0, with no direct replacement 909 */ 910 @Deprecated 911 public static void importPortletInfo(java.lang.String portletId, 912 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 913 java.io.InputStream is) 914 throws com.liferay.portal.kernel.exception.PortalException { 915 getService().importPortletInfo(portletId, parameterMap, is); 916 } 917 918 /** 919 * @deprecated As of 7.0.0, with no direct replacement 920 */ 921 @Deprecated 922 public static long importPortletInfoInBackground( 923 java.lang.String taskName, long plid, long groupId, 924 java.lang.String portletId, 925 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 926 java.io.File file) 927 throws com.liferay.portal.kernel.exception.PortalException { 928 return getService() 929 .importPortletInfoInBackground(taskName, plid, groupId, 930 portletId, parameterMap, file); 931 } 932 933 /** 934 * @deprecated As of 7.0.0, with no direct replacement 935 */ 936 @Deprecated 937 public static long importPortletInfoInBackground( 938 java.lang.String taskName, long plid, long groupId, 939 java.lang.String portletId, 940 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 941 java.io.InputStream is) 942 throws com.liferay.portal.kernel.exception.PortalException { 943 return getService() 944 .importPortletInfoInBackground(taskName, plid, groupId, 945 portletId, parameterMap, is); 946 } 947 948 /** 949 * @deprecated As of 7.0.0, with no direct replacement 950 */ 951 @Deprecated 952 public static void importPortletInfoInBackground( 953 java.lang.String taskName, java.lang.String portletId, 954 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 955 java.io.File file) 956 throws com.liferay.portal.kernel.exception.PortalException { 957 getService() 958 .importPortletInfoInBackground(taskName, portletId, parameterMap, 959 file); 960 } 961 962 /** 963 * @deprecated As of 7.0.0, with no direct replacement 964 */ 965 @Deprecated 966 public static void importPortletInfoInBackground( 967 java.lang.String taskName, java.lang.String portletId, 968 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 969 java.io.InputStream is) 970 throws com.liferay.portal.kernel.exception.PortalException { 971 getService() 972 .importPortletInfoInBackground(taskName, portletId, parameterMap, is); 973 } 974 975 /** 976 * Schedules a range of layouts to be published. 977 * 978 * @param sourceGroupId the primary key of the source group 979 * @param targetGroupId the primary key of the target group 980 * @param privateLayout whether the layout is private to the group 981 * @param layoutIdMap the layouts considered for publishing, specified 982 by the layout IDs and booleans indicating whether they have 983 children 984 * @param parameterMap the mapping of parameters indicating which 985 information will be used. See {@link 986 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 987 * @param groupName the group name (optionally {@link 988 DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). See {@link 989 DestinationNames}. 990 * @param cronText the cron text. See {@link 991 com.liferay.portal.kernel.cal.RecurrenceSerializer 992 #toCronText} 993 * @param schedulerStartDate the scheduler start date 994 * @param schedulerEndDate the scheduler end date 995 * @param description the scheduler description 996 * @throws PortalException if the group did not have permission to 997 manage and publish 998 * @deprecated As of 7.0.0, replaced by {@link #schedulePublishToLive(long, 999 long, boolean, long[], Map, String, Date, Date, String, 1000 String, Date, Date, String)} 1001 */ 1002 @Deprecated 1003 public static void schedulePublishToLive(long sourceGroupId, 1004 long targetGroupId, boolean privateLayout, 1005 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 1006 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1007 java.lang.String scope, java.util.Date startDate, 1008 java.util.Date endDate, java.lang.String groupName, 1009 java.lang.String cronText, java.util.Date schedulerStartDate, 1010 java.util.Date schedulerEndDate, java.lang.String description) 1011 throws com.liferay.portal.kernel.exception.PortalException { 1012 getService() 1013 .schedulePublishToLive(sourceGroupId, targetGroupId, privateLayout, 1014 layoutIdMap, parameterMap, scope, startDate, endDate, groupName, 1015 cronText, schedulerStartDate, schedulerEndDate, description); 1016 } 1017 1018 /** 1019 * Schedules a range of layouts to be published. 1020 * 1021 * @param sourceGroupId the primary key of the source group 1022 * @param targetGroupId the primary key of the target group 1023 * @param privateLayout whether the layout is private to the group 1024 * @param layoutIds the layouts considered for publishing, specified by the 1025 layout IDs 1026 * @param parameterMap the mapping of parameters indicating which 1027 information will be used. See {@link 1028 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1029 * @param groupName the group name (optionally {@link 1030 DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). See {@link 1031 DestinationNames}. 1032 * @param cronText the cron text. See {@link 1033 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 1034 * @param schedulerStartDate the scheduler start date 1035 * @param schedulerEndDate the scheduler end date 1036 * @param description the scheduler description 1037 * @throws PortalException if the group did not have permission to manage 1038 and publish 1039 */ 1040 public static void schedulePublishToLive(long sourceGroupId, 1041 long targetGroupId, boolean privateLayout, long[] layoutIds, 1042 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1043 java.lang.String groupName, java.lang.String cronText, 1044 java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, 1045 java.lang.String description) 1046 throws com.liferay.portal.kernel.exception.PortalException { 1047 getService() 1048 .schedulePublishToLive(sourceGroupId, targetGroupId, privateLayout, 1049 layoutIds, parameterMap, groupName, cronText, schedulerStartDate, 1050 schedulerEndDate, description); 1051 } 1052 1053 /** 1054 * Schedules a range of layouts to be published. 1055 * 1056 * @param sourceGroupId the primary key of the source group 1057 * @param targetGroupId the primary key of the target group 1058 * @param privateLayout whether the layout is private to the group 1059 * @param layoutIds the layouts considered for publishing, specified by 1060 the layout IDs 1061 * @param parameterMap the mapping of parameters indicating which 1062 information will be used. See {@link 1063 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1064 * @param scope the scope of the pages. It can be 1065 <code>all-pages</code> or <code>selected-pages</code>. 1066 * @param startDate the start date 1067 * @param endDate the end date 1068 * @param groupName the group name (optionally {@link 1069 DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). See {@link 1070 DestinationNames}. 1071 * @param cronText the cron text. See {@link 1072 com.liferay.portal.kernel.cal.RecurrenceSerializer 1073 #toCronText} 1074 * @param schedulerStartDate the scheduler start date 1075 * @param schedulerEndDate the scheduler end date 1076 * @param description the scheduler description 1077 * @throws PortalException if the group did not have permission to 1078 manage and publish 1079 * @deprecated As of 7.0.0, replaced by {@link #schedulePublishToLive(long, 1080 long, boolean, long[], Map, String, String, Date, Date, 1081 String)} 1082 */ 1083 @Deprecated 1084 public static void schedulePublishToLive(long sourceGroupId, 1085 long targetGroupId, boolean privateLayout, long[] layoutIds, 1086 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1087 java.lang.String scope, java.util.Date startDate, 1088 java.util.Date endDate, java.lang.String groupName, 1089 java.lang.String cronText, java.util.Date schedulerStartDate, 1090 java.util.Date schedulerEndDate, java.lang.String description) 1091 throws com.liferay.portal.kernel.exception.PortalException { 1092 getService() 1093 .schedulePublishToLive(sourceGroupId, targetGroupId, privateLayout, 1094 layoutIds, parameterMap, scope, startDate, endDate, groupName, 1095 cronText, schedulerStartDate, schedulerEndDate, description); 1096 } 1097 1098 /** 1099 * Schedules a range of layouts to be stored. 1100 * 1101 * @param sourceGroupId the primary key of the source group 1102 * @param privateLayout whether the layout is private to the group 1103 * @param layoutIdMap the layouts considered for publishing, specified by 1104 the layout IDs and booleans indicating whether they have children 1105 * @param parameterMap the mapping of parameters indicating which 1106 information will be used. See {@link 1107 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1108 * @param remoteAddress the remote address 1109 * @param remotePort the remote port 1110 * @param remotePathContext the remote path context 1111 * @param secureConnection whether the connection is secure 1112 * @param remoteGroupId the primary key of the remote group 1113 * @param remotePrivateLayout whether remote group's layout is private 1114 * @param startDate the start date 1115 * @param endDate the end date 1116 * @param groupName the group name. Optionally {@link 1117 DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). See {@link 1118 DestinationNames}. 1119 * @param cronText the cron text. See {@link 1120 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 1121 * @param schedulerStartDate the scheduler start date 1122 * @param schedulerEndDate the scheduler end date 1123 * @param description the scheduler description 1124 * @throws PortalException if a group with the source group primary key was 1125 not found or if the group did not have permission to publish 1126 */ 1127 public static void schedulePublishToRemote(long sourceGroupId, 1128 boolean privateLayout, 1129 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 1130 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1131 java.lang.String remoteAddress, int remotePort, 1132 java.lang.String remotePathContext, boolean secureConnection, 1133 long remoteGroupId, boolean remotePrivateLayout, 1134 java.util.Date startDate, java.util.Date endDate, 1135 java.lang.String groupName, java.lang.String cronText, 1136 java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, 1137 java.lang.String description) 1138 throws com.liferay.portal.kernel.exception.PortalException { 1139 getService() 1140 .schedulePublishToRemote(sourceGroupId, privateLayout, layoutIdMap, 1141 parameterMap, remoteAddress, remotePort, remotePathContext, 1142 secureConnection, remoteGroupId, remotePrivateLayout, startDate, 1143 endDate, groupName, cronText, schedulerStartDate, schedulerEndDate, 1144 description); 1145 } 1146 1147 /** 1148 * Sets the Spring bean ID for this bean. 1149 * 1150 * @param beanIdentifier the Spring bean ID for this bean 1151 */ 1152 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 1153 getService().setBeanIdentifier(beanIdentifier); 1154 } 1155 1156 /** 1157 * Sets the layouts for the group, replacing and prioritizing all layouts of 1158 * the parent layout. 1159 * 1160 * @param groupId the primary key of the group 1161 * @param privateLayout whether the layout is private to the group 1162 * @param parentLayoutId the primary key of the parent layout 1163 * @param layoutIds the primary keys of the layouts 1164 * @param serviceContext the service context to be applied 1165 * @throws PortalException if a group or layout with the primary key could 1166 not be found, if the group did not have permission to manage the 1167 layouts, if no layouts were specified, if the first layout was 1168 not page-able, if the first layout was hidden, or if some other 1169 portal exception occurred 1170 */ 1171 public static void setLayouts(long groupId, boolean privateLayout, 1172 long parentLayoutId, long[] layoutIds, 1173 com.liferay.portal.service.ServiceContext serviceContext) 1174 throws com.liferay.portal.kernel.exception.PortalException { 1175 getService() 1176 .setLayouts(groupId, privateLayout, parentLayoutId, layoutIds, 1177 serviceContext); 1178 } 1179 1180 /** 1181 * Deletes the job from the scheduler's queue. 1182 * 1183 * @param groupId the primary key of the group 1184 * @param jobName the job name 1185 * @param groupName the group name (optionally {@link 1186 DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). See {@link 1187 DestinationNames}. 1188 * @throws PortalException if the group did not permission to manage staging 1189 and publish 1190 */ 1191 public static void unschedulePublishToLive(long groupId, 1192 java.lang.String jobName, java.lang.String groupName) 1193 throws com.liferay.portal.kernel.exception.PortalException { 1194 getService().unschedulePublishToLive(groupId, jobName, groupName); 1195 } 1196 1197 /** 1198 * Deletes the job from the scheduler's persistent queue. 1199 * 1200 * @param groupId the primary key of the group 1201 * @param jobName the job name 1202 * @param groupName the group name (optionally {@link 1203 DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). See {@link 1204 DestinationNames}. 1205 * @throws PortalException if a group with the primary key could not be 1206 found or if the group did not have permission to publish 1207 */ 1208 public static void unschedulePublishToRemote(long groupId, 1209 java.lang.String jobName, java.lang.String groupName) 1210 throws com.liferay.portal.kernel.exception.PortalException { 1211 getService().unschedulePublishToRemote(groupId, jobName, groupName); 1212 } 1213 1214 public static com.liferay.portal.model.Layout updateIconImage(long plid, 1215 byte[] bytes) 1216 throws com.liferay.portal.kernel.exception.PortalException { 1217 return getService().updateIconImage(plid, bytes); 1218 } 1219 1220 /** 1221 * Updates the layout with additional parameters. 1222 * 1223 * @param groupId the primary key of the group 1224 * @param privateLayout whether the layout is private to the group 1225 * @param layoutId the primary key of the layout 1226 * @param parentLayoutId the primary key of the layout's new parent 1227 layout 1228 * @param localeNamesMap the layout's locales and localized names 1229 * @param localeTitlesMap the layout's locales and localized titles 1230 * @param descriptionMap the locales and localized descriptions to 1231 merge (optionally <code>null</code>) 1232 * @param keywordsMap the locales and localized keywords to merge 1233 (optionally <code>null</code>) 1234 * @param robotsMap the locales and localized robots to merge 1235 (optionally <code>null</code>) 1236 * @param type the layout's new type (optionally {@link 1237 LayoutConstants#TYPE_PORTLET}) 1238 * @param hidden whether the layout is hidden 1239 * @param friendlyURL the layout's locales and new friendly URLs. To 1240 see how the URL is normalized when accessed, see {@link 1241 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1242 String)}. 1243 * @param iconImage whether the icon image will be updated 1244 * @param iconBytes the byte array of the layout's new icon image 1245 * @param serviceContext the service context to be applied. Can set the 1246 modification date and expando bridge attributes for the 1247 layout. 1248 * @return the updated layout 1249 * @throws PortalException if a group or layout with the primary key 1250 could not be found, if the user did not have permission to 1251 update the layout, if a unique friendly URL could not be 1252 generated, if a valid parent layout ID to use could not be 1253 found, or if the layout parameters were invalid 1254 * @deprecated As of 6.2.0, replaced by {@link #updateLayout(long, boolean, 1255 long, long, Map, Map, Map, Map, Map, String, boolean, Map, 1256 boolean, byte[], ServiceContext)} 1257 */ 1258 @Deprecated 1259 public static com.liferay.portal.model.Layout updateLayout(long groupId, 1260 boolean privateLayout, long layoutId, long parentLayoutId, 1261 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 1262 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 1263 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1264 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1265 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1266 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 1267 java.lang.Boolean iconImage, byte[] iconBytes, 1268 com.liferay.portal.service.ServiceContext serviceContext) 1269 throws com.liferay.portal.kernel.exception.PortalException { 1270 return getService() 1271 .updateLayout(groupId, privateLayout, layoutId, 1272 parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap, 1273 keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage, 1274 iconBytes, serviceContext); 1275 } 1276 1277 /** 1278 * Updates the layout with additional parameters. 1279 * 1280 * @param groupId the primary key of the group 1281 * @param privateLayout whether the layout is private to the group 1282 * @param layoutId the primary key of the layout 1283 * @param parentLayoutId the primary key of the layout's new parent layout 1284 * @param localeNamesMap the layout's locales and localized names 1285 * @param localeTitlesMap the layout's locales and localized titles 1286 * @param descriptionMap the locales and localized descriptions to merge 1287 (optionally <code>null</code>) 1288 * @param keywordsMap the locales and localized keywords to merge 1289 (optionally <code>null</code>) 1290 * @param robotsMap the locales and localized robots to merge (optionally 1291 <code>null</code>) 1292 * @param type the layout's new type (optionally {@link 1293 LayoutConstants#TYPE_PORTLET}) 1294 * @param hidden whether the layout is hidden 1295 * @param friendlyURLMap the layout's locales and localized friendly URLs. 1296 To see how the URL is normalized when accessed see {@link 1297 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1298 String)}. 1299 * @param iconImage whether the icon image will be updated 1300 * @param iconBytes the byte array of the layout's new icon image 1301 * @param serviceContext the service context to be applied. Can set the 1302 modification date and expando bridge attributes for the layout. 1303 * @return the updated layout 1304 * @throws PortalException if a group or layout with the primary key could 1305 not be found, if the user did not have permission to update the 1306 layout, if a unique friendly URL could not be generated, if a 1307 valid parent layout ID to use could not be found, or if the 1308 layout parameters were invalid 1309 */ 1310 public static com.liferay.portal.model.Layout updateLayout(long groupId, 1311 boolean privateLayout, long layoutId, long parentLayoutId, 1312 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 1313 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 1314 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1315 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1316 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1317 java.lang.String type, boolean hidden, 1318 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 1319 boolean iconImage, byte[] iconBytes, 1320 com.liferay.portal.service.ServiceContext serviceContext) 1321 throws com.liferay.portal.kernel.exception.PortalException { 1322 return getService() 1323 .updateLayout(groupId, privateLayout, layoutId, 1324 parentLayoutId, localeNamesMap, localeTitlesMap, descriptionMap, 1325 keywordsMap, robotsMap, type, hidden, friendlyURLMap, iconImage, 1326 iconBytes, serviceContext); 1327 } 1328 1329 /** 1330 * Updates the layout replacing its type settings. 1331 * 1332 * @param groupId the primary key of the group 1333 * @param privateLayout whether the layout is private to the group 1334 * @param layoutId the primary key of the layout 1335 * @param typeSettings the settings to load the unicode properties object. 1336 See {@link com.liferay.portal.kernel.util.UnicodeProperties 1337 #fastLoad(String)}. 1338 * @return the updated layout 1339 * @throws PortalException if a matching layout could not be found or if the 1340 user did not have permission to update the layout 1341 */ 1342 public static com.liferay.portal.model.Layout updateLayout(long groupId, 1343 boolean privateLayout, long layoutId, java.lang.String typeSettings) 1344 throws com.liferay.portal.kernel.exception.PortalException { 1345 return getService() 1346 .updateLayout(groupId, privateLayout, layoutId, typeSettings); 1347 } 1348 1349 /** 1350 * Updates the look and feel of the layout. 1351 * 1352 * @param groupId the primary key of the group 1353 * @param privateLayout whether the layout is private to the group 1354 * @param layoutId the primary key of the layout 1355 * @param themeId the primary key of the layout's new theme 1356 * @param colorSchemeId the primary key of the layout's new color scheme 1357 * @param css the layout's new CSS 1358 * @param wapTheme whether the theme is for WAP browsers 1359 * @return the updated layout 1360 * @throws PortalException if a matching layout could not be found, or if 1361 the user did not have permission to update the layout and 1362 permission to apply the theme 1363 */ 1364 public static com.liferay.portal.model.Layout updateLookAndFeel( 1365 long groupId, boolean privateLayout, long layoutId, 1366 java.lang.String themeId, java.lang.String colorSchemeId, 1367 java.lang.String css, boolean wapTheme) 1368 throws com.liferay.portal.kernel.exception.PortalException { 1369 return getService() 1370 .updateLookAndFeel(groupId, privateLayout, layoutId, 1371 themeId, colorSchemeId, css, wapTheme); 1372 } 1373 1374 /** 1375 * Updates the name of the layout matching the group, layout ID, and 1376 * privacy. 1377 * 1378 * @param groupId the primary key of the group 1379 * @param privateLayout whether the layout is private to the group 1380 * @param layoutId the primary key of the layout 1381 * @param name the layout's new name 1382 * @param languageId the primary key of the language. For more information 1383 see {@link Locale}. 1384 * @return the updated layout 1385 * @throws PortalException if a matching layout could not be found, if the 1386 user did not have permission to update the layout, or if the new 1387 name was <code>null</code> 1388 */ 1389 public static com.liferay.portal.model.Layout updateName(long groupId, 1390 boolean privateLayout, long layoutId, java.lang.String name, 1391 java.lang.String languageId) 1392 throws com.liferay.portal.kernel.exception.PortalException { 1393 return getService() 1394 .updateName(groupId, privateLayout, layoutId, name, 1395 languageId); 1396 } 1397 1398 /** 1399 * Updates the name of the layout matching the primary key. 1400 * 1401 * @param plid the primary key of the layout 1402 * @param name the name to be assigned 1403 * @param languageId the primary key of the language. For more information 1404 see {@link Locale}. 1405 * @return the updated layout 1406 * @throws PortalException if a layout with the primary key could not be 1407 found, or if the user did not have permission to update the 1408 layout, or if the name was <code>null</code> 1409 */ 1410 public static com.liferay.portal.model.Layout updateName(long plid, 1411 java.lang.String name, java.lang.String languageId) 1412 throws com.liferay.portal.kernel.exception.PortalException { 1413 return getService().updateName(plid, name, languageId); 1414 } 1415 1416 /** 1417 * Updates the parent layout ID of the layout matching the group, layout ID, 1418 * and privacy. 1419 * 1420 * @param groupId the primary key of the group 1421 * @param privateLayout whether the layout is private to the group 1422 * @param layoutId the primary key of the layout 1423 * @param parentLayoutId the primary key to be assigned to the parent 1424 layout 1425 * @return the matching layout 1426 * @throws PortalException if a valid parent layout ID to use could not be 1427 found, if a matching layout could not be found, or if the user 1428 did not have permission to update the layout 1429 */ 1430 public static com.liferay.portal.model.Layout updateParentLayoutId( 1431 long groupId, boolean privateLayout, long layoutId, long parentLayoutId) 1432 throws com.liferay.portal.kernel.exception.PortalException { 1433 return getService() 1434 .updateParentLayoutId(groupId, privateLayout, layoutId, 1435 parentLayoutId); 1436 } 1437 1438 /** 1439 * Updates the parent layout ID of the layout matching the primary key. If a 1440 * layout matching the parent primary key is found, the layout ID of that 1441 * layout is assigned, otherwise {@link 1442 * LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is assigned. 1443 * 1444 * @param plid the primary key of the layout 1445 * @param parentPlid the primary key of the parent layout 1446 * @return the layout matching the primary key 1447 * @throws PortalException if a layout with the primary key could not be 1448 found, if the user did not have permission to update the layout, 1449 or if a valid parent layout ID to use could not be found 1450 */ 1451 public static com.liferay.portal.model.Layout updateParentLayoutId( 1452 long plid, long parentPlid) 1453 throws com.liferay.portal.kernel.exception.PortalException { 1454 return getService().updateParentLayoutId(plid, parentPlid); 1455 } 1456 1457 /** 1458 * Updates the parent layout ID and priority of the layout. 1459 * 1460 * @param plid the primary key of the layout 1461 * @param parentPlid the primary key of the parent layout 1462 * @param priority the layout's new priority 1463 * @return the layout matching the primary key 1464 * @throws PortalException if a portal exception occurred 1465 */ 1466 public static com.liferay.portal.model.Layout updateParentLayoutIdAndPriority( 1467 long plid, long parentPlid, int priority) 1468 throws com.liferay.portal.kernel.exception.PortalException { 1469 return getService() 1470 .updateParentLayoutIdAndPriority(plid, parentPlid, priority); 1471 } 1472 1473 /** 1474 * Updates the priority of the layout matching the group, layout ID, and 1475 * privacy, setting the layout's priority based on the priorities of the 1476 * next and previous layouts. 1477 * 1478 * @param groupId the primary key of the group 1479 * @param privateLayout whether the layout is private to the group 1480 * @param layoutId the primary key of the layout 1481 * @param nextLayoutId the primary key of the next layout 1482 * @param previousLayoutId the primary key of the previous layout 1483 * @return the updated layout 1484 * @throws PortalException if a matching layout could not be found or if the 1485 user did not have permission to update the layout 1486 */ 1487 public static com.liferay.portal.model.Layout updatePriority(long groupId, 1488 boolean privateLayout, long layoutId, long nextLayoutId, 1489 long previousLayoutId) 1490 throws com.liferay.portal.kernel.exception.PortalException { 1491 return getService() 1492 .updatePriority(groupId, privateLayout, layoutId, 1493 nextLayoutId, previousLayoutId); 1494 } 1495 1496 /** 1497 * Updates the priority of the layout matching the group, layout ID, and 1498 * privacy. 1499 * 1500 * @param groupId the primary key of the group 1501 * @param privateLayout whether the layout is private to the group 1502 * @param layoutId the primary key of the layout 1503 * @param priority the layout's new priority 1504 * @return the updated layout 1505 * @throws PortalException if a matching layout could not be found or if the 1506 user did not have permission to update the layout 1507 */ 1508 public static com.liferay.portal.model.Layout updatePriority(long groupId, 1509 boolean privateLayout, long layoutId, int priority) 1510 throws com.liferay.portal.kernel.exception.PortalException { 1511 return getService() 1512 .updatePriority(groupId, privateLayout, layoutId, priority); 1513 } 1514 1515 /** 1516 * Updates the priority of the layout matching the primary key. 1517 * 1518 * @param plid the primary key of the layout 1519 * @param priority the layout's new priority 1520 * @return the updated layout 1521 * @throws PortalException if a layout with the primary key could not be 1522 found 1523 */ 1524 public static com.liferay.portal.model.Layout updatePriority(long plid, 1525 int priority) 1526 throws com.liferay.portal.kernel.exception.PortalException { 1527 return getService().updatePriority(plid, priority); 1528 } 1529 1530 /** 1531 * @deprecated As of 7.0.0, replaced by {@link 1532 com.liferay.portlet.exportimport.service.ExportImportService#validateImportLayoutsFile( 1533 ExportImportConfiguration, File)} 1534 */ 1535 @Deprecated 1536 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 1537 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1538 java.io.File file) 1539 throws com.liferay.portal.kernel.exception.PortalException { 1540 return getService() 1541 .validateImportLayoutsFile(exportImportConfiguration, file); 1542 } 1543 1544 /** 1545 * @deprecated As of 7.0.0, replaced by {@link 1546 com.liferay.portlet.exportimport.service.ExportImportService#validateImportLayoutsFile( 1547 ExportImportConfiguration, InputStream)} 1548 */ 1549 @Deprecated 1550 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 1551 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1552 java.io.InputStream inputStream) 1553 throws com.liferay.portal.kernel.exception.PortalException { 1554 return getService() 1555 .validateImportLayoutsFile(exportImportConfiguration, 1556 inputStream); 1557 } 1558 1559 /** 1560 * @throws PortalException 1561 * @deprecated As of 7.0.0, with no direct replacement 1562 */ 1563 @Deprecated 1564 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 1565 long groupId, boolean privateLayout, 1566 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1567 java.io.File file) 1568 throws com.liferay.portal.kernel.exception.PortalException { 1569 return getService() 1570 .validateImportLayoutsFile(groupId, privateLayout, 1571 parameterMap, file); 1572 } 1573 1574 /** 1575 * @throws PortalException 1576 * @deprecated As of 7.0.0, with no direct replacement 1577 */ 1578 @Deprecated 1579 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 1580 long groupId, boolean privateLayout, 1581 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1582 java.io.InputStream inputStream) 1583 throws com.liferay.portal.kernel.exception.PortalException { 1584 return getService() 1585 .validateImportLayoutsFile(groupId, privateLayout, 1586 parameterMap, inputStream); 1587 } 1588 1589 /** 1590 * @deprecated As of 7.0.0, replaced by {@link 1591 com.liferay.portlet.exportimport.service.ExportImportService#validateImportPortletInfo( 1592 ExportImportConfiguration, File)} 1593 */ 1594 @Deprecated 1595 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 1596 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1597 java.io.File file) 1598 throws com.liferay.portal.kernel.exception.PortalException { 1599 return getService() 1600 .validateImportPortletInfo(exportImportConfiguration, file); 1601 } 1602 1603 /** 1604 * @deprecated As of 7.0.0, replaced by {@link 1605 com.liferay.portlet.exportimport.service.ExportImportService#validateImportPortletInfo( 1606 ExportImportConfiguration, InputStream)} 1607 */ 1608 @Deprecated 1609 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 1610 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1611 java.io.InputStream inputStream) 1612 throws com.liferay.portal.kernel.exception.PortalException { 1613 return getService() 1614 .validateImportPortletInfo(exportImportConfiguration, 1615 inputStream); 1616 } 1617 1618 /** 1619 * @deprecated As of 7.0.0, with no direct replacement 1620 */ 1621 @Deprecated 1622 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 1623 long plid, long groupId, java.lang.String portletId, 1624 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1625 java.io.File file) 1626 throws com.liferay.portal.kernel.exception.PortalException { 1627 return getService() 1628 .validateImportPortletInfo(plid, groupId, portletId, 1629 parameterMap, file); 1630 } 1631 1632 /** 1633 * @deprecated As of 7.0.0, with no direct replacement 1634 */ 1635 @Deprecated 1636 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 1637 long plid, long groupId, java.lang.String portletId, 1638 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1639 java.io.InputStream inputStream) 1640 throws com.liferay.portal.kernel.exception.PortalException { 1641 return getService() 1642 .validateImportPortletInfo(plid, groupId, portletId, 1643 parameterMap, inputStream); 1644 } 1645 1646 public static LayoutService getService() { 1647 if (_service == null) { 1648 _service = (LayoutService)PortalBeanLocatorUtil.locate(LayoutService.class.getName()); 1649 1650 ReferenceRegistry.registerReference(LayoutServiceUtil.class, 1651 "_service"); 1652 } 1653 1654 return _service; 1655 } 1656 1657 /** 1658 * @deprecated As of 6.2.0 1659 */ 1660 @Deprecated 1661 public void setService(LayoutService service) { 1662 } 1663 1664 private static LayoutService _service; 1665 }