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