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 local service utility for Layout. This utility wraps 024 * {@link com.liferay.portal.service.impl.LayoutLocalServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on the local server. Methods of this service will not have security checks 027 * based on the propagated JAAS credentials because this service can only be 028 * accessed from within the same VM. 029 * 030 * @author Brian Wing Shun Chan 031 * @see LayoutLocalService 032 * @see com.liferay.portal.service.base.LayoutLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.LayoutLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class LayoutLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the layout to the database. Also notifies the appropriate model listeners. 046 * 047 * @param layout the layout 048 * @return the layout that was added 049 */ 050 public static com.liferay.portal.model.Layout addLayout( 051 com.liferay.portal.model.Layout layout) { 052 return getService().addLayout(layout); 053 } 054 055 /** 056 * Adds a layout with single entry maps for name, title, and description to 057 * the default locale. 058 * 059 * <p> 060 * This method handles the creation of the layout including its resources, 061 * metadata, and internal data structures. It is not necessary to make 062 * subsequent calls to any methods to setup default groups, resources, ... 063 * etc. 064 * </p> 065 * 066 * @param userId the primary key of the user 067 * @param groupId the primary key of the group 068 * @param privateLayout whether the layout is private to the group 069 * @param parentLayoutId the primary key of the parent layout (optionally 070 {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}). The possible 071 values can be found in {@link LayoutConstants}. 072 * @param name the layout's name (optionally {@link 073 PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_NAME} or {@link 074 PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_NAME}). The default values 075 can be overridden in <code>portal-ext.properties</code> by 076 specifying new values for the corresponding properties defined in 077 {@link PropsValues} 078 * @param title the layout's title 079 * @param description the layout's description 080 * @param type the layout's type (optionally {@link 081 LayoutConstants#TYPE_PORTLET}). The possible types can be found 082 in {@link LayoutConstants}. 083 * @param hidden whether the layout is hidden 084 * @param friendlyURL the friendly URL of the layout (optionally {@link 085 PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} or {@link 086 PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). The 087 default values can be overridden in 088 <code>portal-ext.properties</code> by specifying new values for 089 the corresponding properties defined in {@link PropsValues}. To 090 see how the URL is normalized when accessed, see {@link 091 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 092 String)}. 093 * @param serviceContext the service context to be applied. Must set the 094 UUID for the layout. Can set the creation date and modification 095 date for the layout. For layouts that belong to a layout set 096 prototype, an attribute named <code>layoutUpdateable</code> can 097 be set to specify whether site administrators can modify this 098 page within their site. 099 * @return the layout 100 */ 101 public static com.liferay.portal.model.Layout addLayout(long userId, 102 long groupId, boolean privateLayout, long parentLayoutId, 103 java.lang.String name, java.lang.String title, 104 java.lang.String description, java.lang.String type, boolean hidden, 105 java.lang.String friendlyURL, 106 com.liferay.portal.service.ServiceContext serviceContext) 107 throws com.liferay.portal.kernel.exception.PortalException { 108 return getService() 109 .addLayout(userId, groupId, privateLayout, parentLayoutId, 110 name, title, description, type, hidden, friendlyURL, serviceContext); 111 } 112 113 /** 114 * Adds a layout. 115 * 116 * <p> 117 * This method handles the creation of the layout including its resources, 118 * metadata, and internal data structures. It is not necessary to make 119 * subsequent calls to any methods to setup default groups, resources, ... 120 * etc. 121 * </p> 122 * 123 * @param userId the primary key of the user 124 * @param groupId the primary key of the group 125 * @param privateLayout whether the layout is private to the group 126 * @param parentLayoutId the primary key of the parent layout 127 (optionally {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 128 * @param nameMap the layout's locales and localized names 129 * @param titleMap the layout's locales and localized titles 130 * @param descriptionMap the layout's locales and localized 131 descriptions 132 * @param keywordsMap the layout's locales and localized keywords 133 * @param robotsMap the layout's locales and localized robots 134 * @param type the layout's type (optionally {@link 135 LayoutConstants#TYPE_PORTLET}). The possible types can be 136 found in {@link LayoutConstants}. 137 * @param hidden whether the layout is hidden 138 * @param friendlyURL the layout's friendly URL (optionally {@link 139 PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} or 140 {@link PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). 141 The default values can be overridden in 142 <code>portal-ext.properties</code> by specifying new values 143 for the corresponding properties defined in {@link 144 PropsValues}. To see how the URL is normalized when accessed, 145 see {@link 146 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 147 String)}. 148 * @param serviceContext the service context to be applied. Must set 149 the UUID for the layout. Can set the creation date, 150 modification date and the expando bridge attributes for the 151 layout. For layouts that belong to a layout set prototype, an 152 attribute named <code>layoutUpdateable</code> can be set to 153 specify whether site administrators can modify this page 154 within their site. For layouts that are created from a layout 155 prototype, attributes named <code>layoutPrototypeUuid</code> 156 and <code>layoutPrototypeLinkedEnabled</code> can be 157 specified to provide the unique identifier of the source 158 prototype and a boolean to determine whether a link to it 159 should be enabled to activate propagation of changes made to 160 the linked page in the prototype. 161 * @return the layout 162 * @deprecated As of 6.2.0, replaced by {@link #addLayout(long, long, 163 boolean, long, Map, Map, Map, Map, Map, String, String, 164 boolean, Map, ServiceContext)} 165 */ 166 @Deprecated 167 public static com.liferay.portal.model.Layout addLayout(long userId, 168 long groupId, boolean privateLayout, long parentLayoutId, 169 java.util.Map<java.util.Locale, java.lang.String> nameMap, 170 java.util.Map<java.util.Locale, java.lang.String> titleMap, 171 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 172 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 173 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 174 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 175 com.liferay.portal.service.ServiceContext serviceContext) 176 throws com.liferay.portal.kernel.exception.PortalException { 177 return getService() 178 .addLayout(userId, groupId, privateLayout, parentLayoutId, 179 nameMap, titleMap, descriptionMap, keywordsMap, robotsMap, type, 180 hidden, friendlyURL, serviceContext); 181 } 182 183 /** 184 * Adds a layout with additional parameters. 185 * 186 * <p> 187 * This method handles the creation of the layout including its resources, 188 * metadata, and internal data structures. It is not necessary to make 189 * subsequent calls to any methods to setup default groups, resources, ... 190 * etc. 191 * </p> 192 * 193 * @param userId the primary key of the user 194 * @param groupId the primary key of the group 195 * @param privateLayout whether the layout is private to the group 196 * @param parentLayoutId the primary key of the parent layout (optionally 197 {@link LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 198 * @param nameMap the layout's locales and localized names 199 * @param titleMap the layout's locales and localized titles 200 * @param descriptionMap the layout's locales and localized descriptions 201 * @param keywordsMap the layout's locales and localized keywords 202 * @param robotsMap the layout's locales and localized robots 203 * @param type the layout's type (optionally {@link 204 LayoutConstants#TYPE_PORTLET}). The possible types can be found 205 in {@link LayoutConstants}. 206 * @param typeSettings the settings to load the unicode properties object. 207 See {@link UnicodeProperties #fastLoad(String)}. 208 * @param hidden whether the layout is hidden 209 * @param friendlyURLMap the layout's locales and localized friendly URLs. 210 To see how the URL is normalized when accessed, see {@link 211 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 212 String)}. 213 * @param serviceContext the service context to be applied. Must set the 214 UUID for the layout. Can set the creation date, modification 215 date, and expando bridge attributes for the layout. For layouts 216 that belong to a layout set prototype, an attribute named 217 <code>layoutUpdateable</code> can be set to specify whether site 218 administrators can modify this page within their site. For 219 layouts that are created from a layout prototype, attributes 220 named <code>layoutPrototypeUuid</code> and 221 <code>layoutPrototypeLinkedEnabled</code> can be specified to 222 provide the unique identifier of the source prototype and a 223 boolean to determine whether a link to it should be enabled to 224 activate propagation of changes made to the linked page in the 225 prototype. 226 * @return the layout 227 */ 228 public static com.liferay.portal.model.Layout addLayout(long userId, 229 long groupId, boolean privateLayout, long parentLayoutId, 230 java.util.Map<java.util.Locale, java.lang.String> nameMap, 231 java.util.Map<java.util.Locale, java.lang.String> titleMap, 232 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 233 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 234 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 235 java.lang.String type, java.lang.String typeSettings, boolean hidden, 236 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 237 com.liferay.portal.service.ServiceContext serviceContext) 238 throws com.liferay.portal.kernel.exception.PortalException { 239 return getService() 240 .addLayout(userId, groupId, privateLayout, parentLayoutId, 241 nameMap, titleMap, descriptionMap, keywordsMap, robotsMap, type, 242 typeSettings, hidden, friendlyURLMap, serviceContext); 243 } 244 245 /** 246 * Creates a new layout with the primary key. Does not add the layout to the database. 247 * 248 * @param plid the primary key for the new layout 249 * @return the new layout 250 */ 251 public static com.liferay.portal.model.Layout createLayout(long plid) { 252 return getService().createLayout(plid); 253 } 254 255 /** 256 * Deletes the layout with the primary key, also deleting the layout's child 257 * layouts, and associated resources. 258 * 259 * @param groupId the primary key of the group 260 * @param privateLayout whether the layout is private to the group 261 * @param layoutId the primary key of the layout 262 * @param serviceContext the service context to be applied 263 */ 264 public static void deleteLayout(long groupId, boolean privateLayout, 265 long layoutId, com.liferay.portal.service.ServiceContext serviceContext) 266 throws com.liferay.portal.kernel.exception.PortalException { 267 getService() 268 .deleteLayout(groupId, privateLayout, layoutId, serviceContext); 269 } 270 271 /** 272 * Deletes the layout from the database. Also notifies the appropriate model listeners. 273 * 274 * @param layout the layout 275 * @return the layout that was removed 276 */ 277 public static com.liferay.portal.model.Layout deleteLayout( 278 com.liferay.portal.model.Layout layout) { 279 return getService().deleteLayout(layout); 280 } 281 282 /** 283 * Deletes the layout, its child layouts, and its associated resources. 284 * 285 * @param layout the layout 286 * @param updateLayoutSet whether the layout set's page counter needs to be 287 updated 288 * @param serviceContext the service context to be applied 289 */ 290 public static void deleteLayout(com.liferay.portal.model.Layout layout, 291 boolean updateLayoutSet, 292 com.liferay.portal.service.ServiceContext serviceContext) 293 throws com.liferay.portal.kernel.exception.PortalException { 294 getService().deleteLayout(layout, updateLayoutSet, serviceContext); 295 } 296 297 /** 298 * Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners. 299 * 300 * @param plid the primary key of the layout 301 * @return the layout that was removed 302 * @throws PortalException if a layout with the primary key could not be found 303 */ 304 public static com.liferay.portal.model.Layout deleteLayout(long plid) 305 throws com.liferay.portal.kernel.exception.PortalException { 306 return getService().deleteLayout(plid); 307 } 308 309 /** 310 * Deletes the layout with the plid, also deleting the layout's child 311 * layouts, and associated resources. 312 * 313 * @param plid the primary key of the layout 314 * @param serviceContext the service context to be applied 315 */ 316 public static void deleteLayout(long plid, 317 com.liferay.portal.service.ServiceContext serviceContext) 318 throws com.liferay.portal.kernel.exception.PortalException { 319 getService().deleteLayout(plid, serviceContext); 320 } 321 322 /** 323 * Deletes the group's private or non-private layouts, also deleting the 324 * layouts' child layouts, and associated resources. 325 * 326 * @param groupId the primary key of the group 327 * @param privateLayout whether the layout is private to the group 328 * @param serviceContext the service context to be applied. The parent 329 layout set's page count will be updated by default, unless an 330 attribute named <code>updatePageCount</code> is set to 331 <code>false</code>. 332 */ 333 public static void deleteLayouts(long groupId, boolean privateLayout, 334 com.liferay.portal.service.ServiceContext serviceContext) 335 throws com.liferay.portal.kernel.exception.PortalException { 336 getService().deleteLayouts(groupId, privateLayout, serviceContext); 337 } 338 339 /** 340 * @throws PortalException 341 */ 342 public static com.liferay.portal.model.PersistedModel deletePersistedModel( 343 com.liferay.portal.model.PersistedModel persistedModel) 344 throws com.liferay.portal.kernel.exception.PortalException { 345 return getService().deletePersistedModel(persistedModel); 346 } 347 348 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 349 return getService().dynamicQuery(); 350 } 351 352 /** 353 * Performs a dynamic query on the database and returns the matching rows. 354 * 355 * @param dynamicQuery the dynamic query 356 * @return the matching rows 357 */ 358 public static <T> java.util.List<T> dynamicQuery( 359 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 360 return getService().dynamicQuery(dynamicQuery); 361 } 362 363 /** 364 * Performs a dynamic query on the database and returns a range of the matching rows. 365 * 366 * <p> 367 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 368 * </p> 369 * 370 * @param dynamicQuery the dynamic query 371 * @param start the lower bound of the range of model instances 372 * @param end the upper bound of the range of model instances (not inclusive) 373 * @return the range of matching rows 374 */ 375 public static <T> java.util.List<T> dynamicQuery( 376 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 377 int end) { 378 return getService().dynamicQuery(dynamicQuery, start, end); 379 } 380 381 /** 382 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 383 * 384 * <p> 385 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 386 * </p> 387 * 388 * @param dynamicQuery the dynamic query 389 * @param start the lower bound of the range of model instances 390 * @param end the upper bound of the range of model instances (not inclusive) 391 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 392 * @return the ordered range of matching rows 393 */ 394 public static <T> java.util.List<T> dynamicQuery( 395 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 396 int end, 397 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) { 398 return getService() 399 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 400 } 401 402 /** 403 * Returns the number of rows matching the dynamic query. 404 * 405 * @param dynamicQuery the dynamic query 406 * @return the number of rows matching the dynamic query 407 */ 408 public static long dynamicQueryCount( 409 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 410 return getService().dynamicQueryCount(dynamicQuery); 411 } 412 413 /** 414 * Returns the number of rows matching the dynamic query. 415 * 416 * @param dynamicQuery the dynamic query 417 * @param projection the projection to apply to the query 418 * @return the number of rows matching the dynamic query 419 */ 420 public static long dynamicQueryCount( 421 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 422 com.liferay.portal.kernel.dao.orm.Projection projection) { 423 return getService().dynamicQueryCount(dynamicQuery, projection); 424 } 425 426 /** 427 * Exports layouts with the primary keys and criteria as a byte array. 428 * 429 * @param groupId the primary key of the group 430 * @param privateLayout whether the layout is private to the group 431 * @param layoutIds the primary keys of the layouts to be exported 432 * @param parameterMap the mapping of parameters indicating which 433 information to export. For information on the keys used in 434 the map see {@link 435 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 436 * @param startDate the export's start date 437 * @param endDate the export's end date 438 * @return the layouts as a byte array 439 * @throws PortalException 440 * @deprecated As of 7.0.0, with no direct replacement 441 */ 442 @Deprecated 443 public static byte[] exportLayouts(long groupId, boolean privateLayout, 444 long[] layoutIds, 445 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 446 java.util.Date startDate, java.util.Date endDate) 447 throws com.liferay.portal.kernel.exception.PortalException { 448 return getService() 449 .exportLayouts(groupId, privateLayout, layoutIds, 450 parameterMap, startDate, endDate); 451 } 452 453 /** 454 * Exports all layouts that match the criteria as a byte array. 455 * 456 * @param groupId the primary key of the group 457 * @param privateLayout whether the layout is private to the group 458 * @param parameterMap the mapping of parameters indicating which 459 information to export. For information on the keys used in 460 the map see {@link 461 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 462 * @param startDate the export's start date 463 * @param endDate the export's end date 464 * @return the layout as a byte array 465 * @throws PortalException 466 * @deprecated As of 7.0.0, with no direct replacement 467 */ 468 @Deprecated 469 public static byte[] exportLayouts(long groupId, boolean privateLayout, 470 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 471 java.util.Date startDate, java.util.Date endDate) 472 throws com.liferay.portal.kernel.exception.PortalException { 473 return getService() 474 .exportLayouts(groupId, privateLayout, parameterMap, 475 startDate, endDate); 476 } 477 478 /** 479 * @throws PortalException 480 * @deprecated As of 7.0.0, replaced by {@link 481 com.liferay.portlet.exportimport.service.ExportImportLocalService#exportLayoutsAsFile( 482 ExportImportConfiguration)} 483 */ 484 @Deprecated 485 public static java.io.File exportLayoutsAsFile( 486 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 487 throws com.liferay.portal.kernel.exception.PortalException { 488 return getService().exportLayoutsAsFile(exportImportConfiguration); 489 } 490 491 /** 492 * Exports the layouts that match the primary keys and criteria as a file. 493 * 494 * @param groupId the primary key of the group 495 * @param privateLayout whether the layout is private to the group 496 * @param layoutIds the primary keys of the layouts to be exported 497 (optionally <code>null</code>) 498 * @param parameterMap the mapping of parameters indicating which 499 information to export. For information on the keys used in 500 the map see {@link 501 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 502 * @param startDate the export's start date 503 * @param endDate the export's end date 504 * @return the layouts as a File 505 * @throws PortalException 506 * @deprecated As of 7.0.0, with no direct replacement 507 */ 508 @Deprecated 509 public static java.io.File exportLayoutsAsFile(long groupId, 510 boolean privateLayout, long[] layoutIds, 511 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 512 java.util.Date startDate, java.util.Date endDate) 513 throws com.liferay.portal.kernel.exception.PortalException { 514 return getService() 515 .exportLayoutsAsFile(groupId, privateLayout, layoutIds, 516 parameterMap, startDate, endDate); 517 } 518 519 /** 520 * @throws PortalException 521 * @deprecated As of 7.0.0, replaced by {@link 522 com.liferay.portlet.exportimport.service.ExportImportLocalService#exportLayoutsAsFileInBackground( 523 long, ExportImportConfiguration)} 524 */ 525 @Deprecated 526 public static long exportLayoutsAsFileInBackground(long userId, 527 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 528 throws com.liferay.portal.kernel.exception.PortalException { 529 return getService() 530 .exportLayoutsAsFileInBackground(userId, 531 exportImportConfiguration); 532 } 533 534 /** 535 * @throws PortalException 536 * @deprecated As of 7.0.0, replaced by {@link 537 com.liferay.portlet.exportimport.service.ExportImportLocalService#exportLayoutsAsFileInBackground( 538 long, long)} 539 */ 540 @Deprecated 541 public static long exportLayoutsAsFileInBackground(long userId, 542 long exportImportConfigurationId) 543 throws com.liferay.portal.kernel.exception.PortalException { 544 return getService() 545 .exportLayoutsAsFileInBackground(userId, 546 exportImportConfigurationId); 547 } 548 549 /** 550 * @throws PortalException 551 * @deprecated As of 7.0.0, with no direct replacement 552 */ 553 @Deprecated 554 public static long exportLayoutsAsFileInBackground(long userId, 555 java.lang.String taskName, long groupId, boolean privateLayout, 556 long[] layoutIds, 557 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 558 java.util.Date startDate, java.util.Date endDate) 559 throws com.liferay.portal.kernel.exception.PortalException { 560 return getService() 561 .exportLayoutsAsFileInBackground(userId, taskName, groupId, 562 privateLayout, layoutIds, parameterMap, startDate, endDate); 563 } 564 565 /** 566 * @throws PortalException 567 * @deprecated As of 7.0.0, with no direct replacement 568 */ 569 @Deprecated 570 public static long exportLayoutsAsFileInBackground(long userId, 571 java.lang.String taskName, long groupId, boolean privateLayout, 572 long[] layoutIds, 573 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 574 java.util.Date startDate, java.util.Date endDate, 575 java.lang.String fileName) 576 throws com.liferay.portal.kernel.exception.PortalException { 577 return getService() 578 .exportLayoutsAsFileInBackground(userId, taskName, groupId, 579 privateLayout, layoutIds, parameterMap, startDate, endDate, fileName); 580 } 581 582 /** 583 * @throws PortalException 584 * @deprecated As of 7.0.0, with no direct replacement 585 */ 586 @Deprecated 587 public static byte[] exportPortletInfo(long companyId, 588 java.lang.String portletId, 589 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 590 java.util.Date startDate, java.util.Date endDate) 591 throws com.liferay.portal.kernel.exception.PortalException { 592 return getService() 593 .exportPortletInfo(companyId, portletId, parameterMap, 594 startDate, endDate); 595 } 596 597 /** 598 * Exports the portlet information (categories, permissions, ... etc.) as a 599 * byte array. 600 * 601 * @param plid the primary key of the layout 602 * @param groupId the primary key of the group 603 * @param portletId the primary key of the portlet 604 * @param parameterMap the mapping of parameters indicating which 605 information to export. For information on the keys used in 606 the map see {@link 607 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 608 * @param startDate the export's start date 609 * @param endDate the export's end date 610 * @return the portlet information as a byte array 611 * @throws PortalException 612 * @deprecated As of 7.0.0, with no direct replacement 613 */ 614 @Deprecated 615 public static byte[] exportPortletInfo(long plid, long groupId, 616 java.lang.String portletId, 617 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 618 java.util.Date startDate, java.util.Date endDate) 619 throws com.liferay.portal.kernel.exception.PortalException { 620 return getService() 621 .exportPortletInfo(plid, groupId, portletId, parameterMap, 622 startDate, endDate); 623 } 624 625 /** 626 * @throws PortalException 627 * @deprecated As of 7.0.0, with no direct replacement 628 */ 629 @Deprecated 630 public static java.io.File exportPortletInfoAsFile(long companyId, 631 java.lang.String portletId, 632 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 633 java.util.Date startDate, java.util.Date endDate) 634 throws com.liferay.portal.kernel.exception.PortalException { 635 return getService() 636 .exportPortletInfoAsFile(companyId, portletId, parameterMap, 637 startDate, endDate); 638 } 639 640 /** 641 * @throws PortalException 642 * @deprecated As of 7.0.0, replaced by {@link 643 com.liferay.portlet.exportimport.service.ExportImportLocalService#exportPortletInfoAsFile( 644 ExportImportConfiguration)}} 645 */ 646 @Deprecated 647 public static java.io.File exportPortletInfoAsFile( 648 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 649 throws com.liferay.portal.kernel.exception.PortalException { 650 return getService().exportPortletInfoAsFile(exportImportConfiguration); 651 } 652 653 /** 654 * Exports the portlet information (categories, permissions, ... etc.) as a 655 * file. 656 * 657 * @param plid the primary key of the layout 658 * @param groupId the primary key of the group 659 * @param portletId the primary key of the portlet 660 * @param parameterMap the mapping of parameters indicating which 661 information to export. For information on the keys used in 662 the map see {@link 663 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 664 * @param startDate the export's start date 665 * @param endDate the export's end date 666 * @return the portlet information as a file 667 * @throws PortalException 668 * @deprecated As of 7.0.0, with no direct replacement 669 */ 670 @Deprecated 671 public static java.io.File exportPortletInfoAsFile(long plid, long groupId, 672 java.lang.String portletId, 673 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 674 java.util.Date startDate, java.util.Date endDate) 675 throws com.liferay.portal.kernel.exception.PortalException { 676 return getService() 677 .exportPortletInfoAsFile(plid, groupId, portletId, 678 parameterMap, startDate, endDate); 679 } 680 681 /** 682 * @throws PortalException 683 * @deprecated As of 7.0.0, replaced by {@link 684 com.liferay.portlet.exportimport.service.ExportImportLocalService#exportPortletInfoAsFileInBackground( 685 long, ExportImportConfiguration)}} 686 */ 687 @Deprecated 688 public static long exportPortletInfoAsFileInBackground(long userId, 689 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration) 690 throws com.liferay.portal.kernel.exception.PortalException { 691 return getService() 692 .exportPortletInfoAsFileInBackground(userId, 693 exportImportConfiguration); 694 } 695 696 /** 697 * @throws PortalException 698 * @deprecated As of 7.0.0, replaced by {@link 699 com.liferay.portlet.exportimport.service.ExportImportLocalService#exportPortletInfoAsFileInBackground( 700 long, long)}} 701 */ 702 @Deprecated 703 public static long exportPortletInfoAsFileInBackground(long userId, 704 long exportImportConfigurationId) 705 throws com.liferay.portal.kernel.exception.PortalException { 706 return getService() 707 .exportPortletInfoAsFileInBackground(userId, 708 exportImportConfigurationId); 709 } 710 711 /** 712 * @throws PortalException 713 * @deprecated As of 7.0.0, with no direct replacement 714 */ 715 @Deprecated 716 public static long exportPortletInfoAsFileInBackground(long userId, 717 java.lang.String taskName, long plid, long groupId, 718 java.lang.String portletId, 719 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 720 java.util.Date startDate, java.util.Date endDate, 721 java.lang.String fileName) 722 throws com.liferay.portal.kernel.exception.PortalException { 723 return getService() 724 .exportPortletInfoAsFileInBackground(userId, taskName, plid, 725 groupId, portletId, parameterMap, startDate, endDate, fileName); 726 } 727 728 /** 729 * @throws PortalException 730 * @deprecated As of 7.0.0, with no direct replacement 731 */ 732 @Deprecated 733 public static long exportPortletInfoAsFileInBackground(long userId, 734 java.lang.String taskName, java.lang.String portletId, 735 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 736 java.util.Date startDate, java.util.Date endDate, 737 java.lang.String fileName) 738 throws com.liferay.portal.kernel.exception.PortalException { 739 return getService() 740 .exportPortletInfoAsFileInBackground(userId, taskName, 741 portletId, parameterMap, startDate, endDate, fileName); 742 } 743 744 public static com.liferay.portal.model.Layout fetchFirstLayout( 745 long groupId, boolean privateLayout, long parentLayoutId) { 746 return getService() 747 .fetchFirstLayout(groupId, privateLayout, parentLayoutId); 748 } 749 750 public static com.liferay.portal.model.Layout fetchLayout(long groupId, 751 boolean privateLayout, long layoutId) { 752 return getService().fetchLayout(groupId, privateLayout, layoutId); 753 } 754 755 public static com.liferay.portal.model.Layout fetchLayout(long plid) { 756 return getService().fetchLayout(plid); 757 } 758 759 public static com.liferay.portal.model.Layout fetchLayoutByFriendlyURL( 760 long groupId, boolean privateLayout, java.lang.String friendlyURL) { 761 return getService() 762 .fetchLayoutByFriendlyURL(groupId, privateLayout, friendlyURL); 763 } 764 765 /** 766 * Returns the layout matching the UUID, group, and privacy. 767 * 768 * @param uuid the layout's UUID 769 * @param groupId the primary key of the group 770 * @param privateLayout whether the layout is private to the group 771 * @return the matching layout, or <code>null</code> if a matching layout could not be found 772 */ 773 public static com.liferay.portal.model.Layout fetchLayoutByUuidAndGroupId( 774 java.lang.String uuid, long groupId, boolean privateLayout) { 775 return getService() 776 .fetchLayoutByUuidAndGroupId(uuid, groupId, privateLayout); 777 } 778 779 public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { 780 return getService().getActionableDynamicQuery(); 781 } 782 783 /** 784 * Returns the primary key of the default layout for the group 785 * 786 * @param groupId the primary key of the group 787 * @return the primary key of the default layout for the group (optionally 788 {@link LayoutConstants#DEFAULT_PLID}) 789 */ 790 public static long getDefaultPlid(long groupId) { 791 return getService().getDefaultPlid(groupId); 792 } 793 794 /** 795 * Returns primary key of the matching default layout for the group 796 * 797 * @param groupId the primary key of the group 798 * @param privateLayout whether the layout is private to the group 799 * @return the primary key of the default layout for the group; {@link 800 LayoutConstants#DEFAULT_PLID}) otherwise 801 */ 802 public static long getDefaultPlid(long groupId, boolean privateLayout) { 803 return getService().getDefaultPlid(groupId, privateLayout); 804 } 805 806 /** 807 * Returns primary key of the default portlet layout for the group 808 * 809 * @param groupId the primary key of the group 810 * @param privateLayout whether the layout is private to the group 811 * @param portletId the primary key of the portlet 812 * @return the primary key of the default portlet layout for the group; 813 {@link LayoutConstants#DEFAULT_PLID} otherwise 814 * @throws PortalException 815 */ 816 public static long getDefaultPlid(long groupId, boolean privateLayout, 817 java.lang.String portletId) 818 throws com.liferay.portal.kernel.exception.PortalException { 819 return getService().getDefaultPlid(groupId, privateLayout, portletId); 820 } 821 822 public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 823 com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext) { 824 return getService().getExportActionableDynamicQuery(portletDataContext); 825 } 826 827 /** 828 * Returns the layout for the friendly URL 829 * 830 * @param groupId the primary key of the group 831 * @param privateLayout whether the layout is private to the group 832 * @param friendlyURL the friendly URL of the layout 833 * @return the layout for the friendly URL 834 */ 835 public static com.liferay.portal.model.Layout getFriendlyURLLayout( 836 long groupId, boolean privateLayout, java.lang.String friendlyURL) 837 throws com.liferay.portal.kernel.exception.PortalException { 838 return getService() 839 .getFriendlyURLLayout(groupId, privateLayout, friendlyURL); 840 } 841 842 /** 843 * Returns the layout matching the primary key, group, and privacy; throws a 844 * {@link NoSuchLayoutException} otherwise. 845 * 846 * @param groupId the primary key of the group 847 * @param privateLayout whether the layout is private to the group 848 * @param layoutId the primary key of the layout 849 * @return the matching layout 850 */ 851 public static com.liferay.portal.model.Layout getLayout(long groupId, 852 boolean privateLayout, long layoutId) 853 throws com.liferay.portal.kernel.exception.PortalException { 854 return getService().getLayout(groupId, privateLayout, layoutId); 855 } 856 857 /** 858 * Returns the layout with the primary key. 859 * 860 * @param plid the primary key of the layout 861 * @return the layout 862 * @throws PortalException if a layout with the primary key could not be found 863 */ 864 public static com.liferay.portal.model.Layout getLayout(long plid) 865 throws com.liferay.portal.kernel.exception.PortalException { 866 return getService().getLayout(plid); 867 } 868 869 /** 870 * Returns the layout for the icon image; throws a {@link 871 * NoSuchLayoutException} otherwise. 872 * 873 * @param iconImageId the primary key of the icon image 874 * @return Returns the layout for the icon image 875 */ 876 public static com.liferay.portal.model.Layout getLayoutByIconImageId( 877 long iconImageId) 878 throws com.liferay.portal.kernel.exception.PortalException { 879 return getService().getLayoutByIconImageId(iconImageId); 880 } 881 882 /** 883 * Returns the layout matching the UUID, group, and privacy. 884 * 885 * @param uuid the layout's UUID 886 * @param groupId the primary key of the group 887 * @param privateLayout whether the layout is private to the group 888 * @return the matching layout 889 * @throws PortalException if a matching layout could not be found 890 */ 891 public static com.liferay.portal.model.Layout getLayoutByUuidAndGroupId( 892 java.lang.String uuid, long groupId, boolean privateLayout) 893 throws com.liferay.portal.kernel.exception.PortalException { 894 return getService() 895 .getLayoutByUuidAndGroupId(uuid, groupId, privateLayout); 896 } 897 898 /** 899 * Returns the layout references for all the layouts that belong to the 900 * company and belong to the portlet that matches the preferences. 901 * 902 * @param companyId the primary key of the company 903 * @param portletId the primary key of the portlet 904 * @param preferencesKey the portlet's preference key 905 * @param preferencesValue the portlet's preference value 906 * @return the layout references of the matching layouts 907 */ 908 public static com.liferay.portal.model.LayoutReference[] getLayouts( 909 long companyId, java.lang.String portletId, 910 java.lang.String preferencesKey, java.lang.String preferencesValue) { 911 return getService() 912 .getLayouts(companyId, portletId, preferencesKey, 913 preferencesValue); 914 } 915 916 /** 917 * Returns all the layouts belonging to the group. 918 * 919 * @param groupId the primary key of the group 920 * @param privateLayout whether the layout is private to the group 921 * @return the matching layouts, or <code>null</code> if no matches were 922 found 923 */ 924 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 925 long groupId, boolean privateLayout) { 926 return getService().getLayouts(groupId, privateLayout); 927 } 928 929 /** 930 * Returns all the layouts that match the layout IDs and belong to the 931 * group. 932 * 933 * @param groupId the primary key of the group 934 * @param privateLayout whether the layout is private to the group 935 * @param layoutIds the primary keys of the layouts 936 * @return the matching layouts, or an empty list if no matches were found 937 */ 938 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 939 long groupId, boolean privateLayout, long[] layoutIds) 940 throws com.liferay.portal.kernel.exception.PortalException { 941 return getService().getLayouts(groupId, privateLayout, layoutIds); 942 } 943 944 /** 945 * Returns all the layouts belonging to the group that are children of the 946 * parent layout. 947 * 948 * @param groupId the primary key of the group 949 * @param privateLayout whether the layout is private to the group 950 * @param parentLayoutId the primary key of the parent layout 951 * @return the matching layouts, or <code>null</code> if no matches were 952 found 953 */ 954 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 955 long groupId, boolean privateLayout, long parentLayoutId) { 956 return getService().getLayouts(groupId, privateLayout, parentLayoutId); 957 } 958 959 /** 960 * Returns a range of all the layouts belonging to the group that are 961 * children of the parent layout. 962 * 963 * <p> 964 * Useful when paginating results. Returns a maximum of <code>end - 965 * start</code> instances. <code>start</code> and <code>end</code> are not 966 * primary keys, they are indexes in the result set. Thus, <code>0</code> 967 * refers to the first result in the set. Setting both <code>start</code> 968 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 969 * result set. 970 * </p> 971 * 972 * @param groupId the primary key of the group 973 * @param privateLayout whether the layout is private to the group 974 * @param parentLayoutId the primary key of the parent layout 975 * @param incomplete whether the layout is incomplete 976 * @param start the lower bound of the range of layouts 977 * @param end the upper bound of the range of layouts (not inclusive) 978 * @return the matching layouts, or <code>null</code> if no matches were 979 found 980 */ 981 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 982 long groupId, boolean privateLayout, long parentLayoutId, 983 boolean incomplete, int start, int end) { 984 return getService() 985 .getLayouts(groupId, privateLayout, parentLayoutId, 986 incomplete, start, end); 987 } 988 989 /** 990 * Returns all the layouts that match the type and belong to the group. 991 * 992 * @param groupId the primary key of the group 993 * @param privateLayout whether the layout is private to the group 994 * @param type the type of the layouts (optionally {@link 995 LayoutConstants#TYPE_PORTLET}) 996 * @return the matching layouts, or <code>null</code> if no matches were 997 found 998 */ 999 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 1000 long groupId, boolean privateLayout, java.lang.String type) { 1001 return getService().getLayouts(groupId, privateLayout, type); 1002 } 1003 1004 /** 1005 * Returns a range of all the layouts. 1006 * 1007 * <p> 1008 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 1009 * </p> 1010 * 1011 * @param start the lower bound of the range of layouts 1012 * @param end the upper bound of the range of layouts (not inclusive) 1013 * @return the range of layouts 1014 */ 1015 public static java.util.List<com.liferay.portal.model.Layout> getLayouts( 1016 int start, int end) { 1017 return getService().getLayouts(start, end); 1018 } 1019 1020 public static java.util.List<com.liferay.portal.model.Layout> getLayoutsByLayoutPrototypeUuid( 1021 java.lang.String layoutPrototypeUuid) { 1022 return getService().getLayoutsByLayoutPrototypeUuid(layoutPrototypeUuid); 1023 } 1024 1025 public static int getLayoutsByLayoutPrototypeUuidCount( 1026 java.lang.String layoutPrototypeUuid) { 1027 return getService() 1028 .getLayoutsByLayoutPrototypeUuidCount(layoutPrototypeUuid); 1029 } 1030 1031 /** 1032 * Returns all the layouts matching the UUID and company. 1033 * 1034 * @param uuid the UUID of the layouts 1035 * @param companyId the primary key of the company 1036 * @return the matching layouts, or an empty list if no matches were found 1037 */ 1038 public static java.util.List<com.liferay.portal.model.Layout> getLayoutsByUuidAndCompanyId( 1039 java.lang.String uuid, long companyId) { 1040 return getService().getLayoutsByUuidAndCompanyId(uuid, companyId); 1041 } 1042 1043 /** 1044 * Returns a range of layouts matching the UUID and company. 1045 * 1046 * @param uuid the UUID of the layouts 1047 * @param companyId the primary key of the company 1048 * @param start the lower bound of the range of layouts 1049 * @param end the upper bound of the range of layouts (not inclusive) 1050 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1051 * @return the range of matching layouts, or an empty list if no matches were found 1052 */ 1053 public static java.util.List<com.liferay.portal.model.Layout> getLayoutsByUuidAndCompanyId( 1054 java.lang.String uuid, long companyId, int start, int end, 1055 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Layout> orderByComparator) { 1056 return getService() 1057 .getLayoutsByUuidAndCompanyId(uuid, companyId, start, end, 1058 orderByComparator); 1059 } 1060 1061 /** 1062 * Returns the number of layouts. 1063 * 1064 * @return the number of layouts 1065 */ 1066 public static int getLayoutsCount() { 1067 return getService().getLayoutsCount(); 1068 } 1069 1070 public static int getLayoutsCount(com.liferay.portal.model.Group group, 1071 boolean privateLayout) 1072 throws com.liferay.portal.kernel.exception.PortalException { 1073 return getService().getLayoutsCount(group, privateLayout); 1074 } 1075 1076 public static int getLayoutsCount(com.liferay.portal.model.Group group, 1077 boolean privateLayout, boolean includeUserGroups) 1078 throws com.liferay.portal.kernel.exception.PortalException { 1079 return getService() 1080 .getLayoutsCount(group, privateLayout, includeUserGroups); 1081 } 1082 1083 public static int getLayoutsCount(com.liferay.portal.model.Group group, 1084 boolean privateLayout, long parentLayoutId) { 1085 return getService().getLayoutsCount(group, privateLayout, parentLayoutId); 1086 } 1087 1088 public static int getLayoutsCount(com.liferay.portal.model.User user, 1089 boolean privateLayout) 1090 throws com.liferay.portal.kernel.exception.PortalException { 1091 return getService().getLayoutsCount(user, privateLayout); 1092 } 1093 1094 public static int getLayoutsCount(com.liferay.portal.model.User user, 1095 boolean privateLayout, boolean includeUserGroups) 1096 throws com.liferay.portal.kernel.exception.PortalException { 1097 return getService() 1098 .getLayoutsCount(user, privateLayout, includeUserGroups); 1099 } 1100 1101 /** 1102 * Returns the primary key to use for the next layout. 1103 * 1104 * @param groupId the primary key of the group 1105 * @param privateLayout whether the layout is private to the group 1106 * @return the primary key to use for the next layout 1107 */ 1108 public static long getNextLayoutId(long groupId, boolean privateLayout) { 1109 return getService().getNextLayoutId(groupId, privateLayout); 1110 } 1111 1112 /** 1113 * Returns all the layouts without resource permissions 1114 * 1115 * @param roleId the primary key of the role 1116 * @return all the layouts without resource permissions 1117 */ 1118 public static java.util.List<com.liferay.portal.model.Layout> getNoPermissionLayouts( 1119 long roleId) { 1120 return getService().getNoPermissionLayouts(roleId); 1121 } 1122 1123 /** 1124 * Returns all the layouts whose friendly URLs are <code>null</code> 1125 * 1126 * @return all the layouts whose friendly URLs are <code>null</code> 1127 */ 1128 public static java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts() { 1129 return getService().getNullFriendlyURLLayouts(); 1130 } 1131 1132 /** 1133 * Returns the OSGi service identifier. 1134 * 1135 * @return the OSGi service identifier 1136 */ 1137 public static java.lang.String getOSGiServiceIdentifier() { 1138 return getService().getOSGiServiceIdentifier(); 1139 } 1140 1141 public static com.liferay.portal.model.Layout getParentLayout( 1142 com.liferay.portal.model.Layout layout) 1143 throws com.liferay.portal.kernel.exception.PortalException { 1144 return getService().getParentLayout(layout); 1145 } 1146 1147 public static com.liferay.portal.model.PersistedModel getPersistedModel( 1148 java.io.Serializable primaryKeyObj) 1149 throws com.liferay.portal.kernel.exception.PortalException { 1150 return getService().getPersistedModel(primaryKeyObj); 1151 } 1152 1153 /** 1154 * Returns all the layouts within scope of the group 1155 * 1156 * @param groupId the primary key of the group 1157 * @param privateLayout whether the layout is private to the group 1158 * @return the layouts within scope of the group 1159 */ 1160 public static java.util.List<com.liferay.portal.model.Layout> getScopeGroupLayouts( 1161 long groupId, boolean privateLayout) { 1162 return getService().getScopeGroupLayouts(groupId, privateLayout); 1163 } 1164 1165 public static boolean hasLayoutSetPrototypeLayout( 1166 long layoutSetPrototypeId, java.lang.String layoutUuid) 1167 throws com.liferay.portal.kernel.exception.PortalException { 1168 return getService() 1169 .hasLayoutSetPrototypeLayout(layoutSetPrototypeId, layoutUuid); 1170 } 1171 1172 public static boolean hasLayoutSetPrototypeLayout( 1173 java.lang.String layoutSetPrototypeUuid, long companyId, 1174 java.lang.String layoutUuid) 1175 throws com.liferay.portal.kernel.exception.PortalException { 1176 return getService() 1177 .hasLayoutSetPrototypeLayout(layoutSetPrototypeUuid, 1178 companyId, layoutUuid); 1179 } 1180 1181 public static boolean hasLayouts(com.liferay.portal.model.Group group) 1182 throws com.liferay.portal.kernel.exception.PortalException { 1183 return getService().hasLayouts(group); 1184 } 1185 1186 public static boolean hasLayouts(com.liferay.portal.model.Group group, 1187 boolean privateLayout) 1188 throws com.liferay.portal.kernel.exception.PortalException { 1189 return getService().hasLayouts(group, privateLayout); 1190 } 1191 1192 public static boolean hasLayouts(com.liferay.portal.model.Group group, 1193 boolean privateLayout, boolean includeUserGroups) 1194 throws com.liferay.portal.kernel.exception.PortalException { 1195 return getService().hasLayouts(group, privateLayout, includeUserGroups); 1196 } 1197 1198 /** 1199 * Returns <code>true</code> if the group has any layouts; 1200 * <code>false</code> otherwise. 1201 * 1202 * @param groupId the primary key of the group 1203 * @param privateLayout whether the layout is private to the group 1204 * @param parentLayoutId the primary key of the parent layout 1205 * @return <code>true</code> if the group has any layouts; 1206 <code>false</code> otherwise 1207 */ 1208 public static boolean hasLayouts(long groupId, boolean privateLayout, 1209 long parentLayoutId) { 1210 return getService().hasLayouts(groupId, privateLayout, parentLayoutId); 1211 } 1212 1213 public static boolean hasLayouts(com.liferay.portal.model.User user, 1214 boolean privateLayout) 1215 throws com.liferay.portal.kernel.exception.PortalException { 1216 return getService().hasLayouts(user, privateLayout); 1217 } 1218 1219 public static boolean hasLayouts(com.liferay.portal.model.User user, 1220 boolean privateLayout, boolean includeUserGroups) 1221 throws com.liferay.portal.kernel.exception.PortalException { 1222 return getService().hasLayouts(user, privateLayout, includeUserGroups); 1223 } 1224 1225 /** 1226 * @throws PortalException 1227 * @deprecated As of 7.0.0, replaced by {@link 1228 com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayouts( 1229 ExportImportConfiguration, File)}} 1230 */ 1231 @Deprecated 1232 public static void importLayouts( 1233 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1234 java.io.File file) 1235 throws com.liferay.portal.kernel.exception.PortalException { 1236 getService().importLayouts(exportImportConfiguration, file); 1237 } 1238 1239 /** 1240 * @throws PortalException 1241 * @deprecated As of 7.0.0, replaced by {@link 1242 com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayouts( 1243 ExportImportConfiguration, InputStream)}} 1244 */ 1245 @Deprecated 1246 public static void importLayouts( 1247 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1248 java.io.InputStream is) 1249 throws com.liferay.portal.kernel.exception.PortalException { 1250 getService().importLayouts(exportImportConfiguration, is); 1251 } 1252 1253 /** 1254 * Imports the layouts from the byte array. 1255 * 1256 * @param userId the primary key of the user 1257 * @param groupId the primary key of the group 1258 * @param privateLayout whether the layout is private to the group 1259 * @param parameterMap the mapping of parameters indicating which 1260 information will be imported. For information on the keys 1261 used in the map see {@link 1262 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1263 * @param bytes the byte array with the data 1264 * @throws PortalException 1265 * @see com.liferay.portlet.exportimport.lar.LayoutImporter 1266 * @deprecated As of 7.0.0, with no direct replacement 1267 */ 1268 @Deprecated 1269 public static void importLayouts(long userId, long groupId, 1270 boolean privateLayout, 1271 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1272 byte[] bytes) 1273 throws com.liferay.portal.kernel.exception.PortalException { 1274 getService() 1275 .importLayouts(userId, groupId, privateLayout, parameterMap, bytes); 1276 } 1277 1278 /** 1279 * Imports the layouts from the file. 1280 * 1281 * @param userId the primary key of the user 1282 * @param groupId the primary key of the group 1283 * @param privateLayout whether the layout is private to the group 1284 * @param parameterMap the mapping of parameters indicating which 1285 information will be imported. For information on the keys 1286 used in the map see {@link 1287 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1288 * @param file the LAR file with the data 1289 * @throws PortalException 1290 * @see com.liferay.portlet.exportimport.lar.LayoutImporter 1291 * @deprecated As of 7.0.0, with no direct replacement 1292 */ 1293 @Deprecated 1294 public static void importLayouts(long userId, long groupId, 1295 boolean privateLayout, 1296 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1297 java.io.File file) 1298 throws com.liferay.portal.kernel.exception.PortalException { 1299 getService() 1300 .importLayouts(userId, groupId, privateLayout, parameterMap, file); 1301 } 1302 1303 /** 1304 * Imports the layouts from the input stream. 1305 * 1306 * @param userId the primary key of the user 1307 * @param groupId the primary key of the group 1308 * @param privateLayout whether the layout is private to the group 1309 * @param parameterMap the mapping of parameters indicating which 1310 information will be imported. For information on the keys 1311 used in the map see {@link 1312 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1313 * @param is the input stream 1314 * @throws PortalException 1315 * @see com.liferay.portlet.exportimport.lar.LayoutImporter 1316 * @deprecated As of 7.0.0, with no direct replacement 1317 */ 1318 @Deprecated 1319 public static void importLayouts(long userId, long groupId, 1320 boolean privateLayout, 1321 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1322 java.io.InputStream is) 1323 throws com.liferay.portal.kernel.exception.PortalException { 1324 getService() 1325 .importLayouts(userId, groupId, privateLayout, parameterMap, is); 1326 } 1327 1328 /** 1329 * @throws PortalException 1330 * @deprecated As of 7.0.0, replaced by {@link 1331 com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayoutsDataDeletions( 1332 ExportImportConfiguration, File)} 1333 */ 1334 @Deprecated 1335 public static void importLayoutsDataDeletions( 1336 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1337 java.io.File file) 1338 throws com.liferay.portal.kernel.exception.PortalException { 1339 getService().importLayoutsDataDeletions(exportImportConfiguration, file); 1340 } 1341 1342 /** 1343 * @throws PortalException 1344 * @deprecated As of 7.0.0, replaced by {@link 1345 com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayoutsInBackground( 1346 long, ExportImportConfiguration, File)} 1347 */ 1348 @Deprecated 1349 public static long importLayoutsInBackground(long userId, 1350 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1351 java.io.File file) 1352 throws com.liferay.portal.kernel.exception.PortalException { 1353 return getService() 1354 .importLayoutsInBackground(userId, 1355 exportImportConfiguration, file); 1356 } 1357 1358 /** 1359 * @throws PortalException 1360 * @deprecated As of 7.0.0, replaced by {@link 1361 com.liferay.portlet.exportimport.service.ExportImportLocalService#importLayoutsInBackground( 1362 long, long, File)} 1363 */ 1364 @Deprecated 1365 public static long importLayoutsInBackground(long userId, 1366 long exportImportConfigurationId, java.io.File file) 1367 throws com.liferay.portal.kernel.exception.PortalException { 1368 return getService() 1369 .importLayoutsInBackground(userId, 1370 exportImportConfigurationId, file); 1371 } 1372 1373 /** 1374 * @throws PortalException 1375 * @deprecated As of 7.0.0, with no direct replacement 1376 */ 1377 @Deprecated 1378 public static long importLayoutsInBackground(long userId, 1379 java.lang.String taskName, long groupId, boolean privateLayout, 1380 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1381 java.io.File file) 1382 throws com.liferay.portal.kernel.exception.PortalException { 1383 return getService() 1384 .importLayoutsInBackground(userId, taskName, groupId, 1385 privateLayout, parameterMap, file); 1386 } 1387 1388 /** 1389 * @throws PortalException 1390 * @deprecated As of 7.0.0, with no direct replacement 1391 */ 1392 @Deprecated 1393 public static long importLayoutsInBackground(long userId, 1394 java.lang.String taskName, long groupId, boolean privateLayout, 1395 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1396 java.io.InputStream is) 1397 throws com.liferay.portal.kernel.exception.PortalException { 1398 return getService() 1399 .importLayoutsInBackground(userId, taskName, groupId, 1400 privateLayout, parameterMap, is); 1401 } 1402 1403 /** 1404 * @throws PortalException 1405 * @deprecated As of 7.0.0, replaced by {@link 1406 com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletDataDeletions( 1407 ExportImportConfiguration, File)} 1408 */ 1409 @Deprecated 1410 public static void importPortletDataDeletions( 1411 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1412 java.io.File file) 1413 throws com.liferay.portal.kernel.exception.PortalException { 1414 getService().importPortletDataDeletions(exportImportConfiguration, file); 1415 } 1416 1417 /** 1418 * @throws PortalException 1419 * @deprecated As of 7.0.0, replaced by {@link 1420 com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfo( 1421 ExportImportConfiguration, File)} 1422 */ 1423 @Deprecated 1424 public static void importPortletInfo( 1425 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1426 java.io.File file) 1427 throws com.liferay.portal.kernel.exception.PortalException { 1428 getService().importPortletInfo(exportImportConfiguration, file); 1429 } 1430 1431 /** 1432 * @throws PortalException 1433 * @deprecated As of 7.0.0, replaced by {@link 1434 com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfo( 1435 ExportImportConfiguration, InputStream)} 1436 */ 1437 @Deprecated 1438 public static void importPortletInfo( 1439 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1440 java.io.InputStream is) 1441 throws com.liferay.portal.kernel.exception.PortalException { 1442 getService().importPortletInfo(exportImportConfiguration, is); 1443 } 1444 1445 /** 1446 * Imports the portlet information (categories, permissions, ... etc.) from 1447 * the file. 1448 * 1449 * @param userId the primary key of the user 1450 * @param plid the primary key of the target layout 1451 * @param groupId the primary key of the target group 1452 * @param portletId the primary key of the portlet 1453 * @param parameterMap the mapping of parameters indicating which 1454 information will be imported. For information on the keys 1455 used in the map see {@link 1456 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1457 * @param file the LAR file with the data 1458 * @throws PortalException 1459 * @deprecated As of 7.0.0, with no direct replacement 1460 */ 1461 @Deprecated 1462 public static void importPortletInfo(long userId, long plid, long groupId, 1463 java.lang.String portletId, 1464 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1465 java.io.File file) 1466 throws com.liferay.portal.kernel.exception.PortalException { 1467 getService() 1468 .importPortletInfo(userId, plid, groupId, portletId, parameterMap, 1469 file); 1470 } 1471 1472 /** 1473 * Imports the portlet information (categories, permissions, ... etc.) from 1474 * the input stream. 1475 * 1476 * @param userId the primary key of the user 1477 * @param plid the primary key of the layout 1478 * @param groupId the primary key of the group 1479 * @param portletId the primary key of the portlet 1480 * @param parameterMap the mapping of parameters indicating which 1481 information will be imported. For information on the keys 1482 used in the map see {@link 1483 com.liferay.portlet.exportimport.lar.PortletDataHandlerKeys}. 1484 * @param is the input stream 1485 * @throws PortalException 1486 * @deprecated As of 7.0.0, with no direct replacement 1487 */ 1488 @Deprecated 1489 public static void importPortletInfo(long userId, long plid, long groupId, 1490 java.lang.String portletId, 1491 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1492 java.io.InputStream is) 1493 throws com.liferay.portal.kernel.exception.PortalException { 1494 getService() 1495 .importPortletInfo(userId, plid, groupId, portletId, parameterMap, 1496 is); 1497 } 1498 1499 /** 1500 * @throws PortalException 1501 * @deprecated As of 7.0.0, with no direct replacement 1502 */ 1503 @Deprecated 1504 public static void importPortletInfo(long userId, 1505 java.lang.String portletId, 1506 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1507 java.io.File file) 1508 throws com.liferay.portal.kernel.exception.PortalException { 1509 getService().importPortletInfo(userId, portletId, parameterMap, file); 1510 } 1511 1512 /** 1513 * @throws PortalException 1514 * @deprecated As of 7.0.0, with no direct replacement 1515 */ 1516 @Deprecated 1517 public static void importPortletInfo(long userId, 1518 java.lang.String portletId, 1519 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1520 java.io.InputStream is) 1521 throws com.liferay.portal.kernel.exception.PortalException { 1522 getService().importPortletInfo(userId, portletId, parameterMap, is); 1523 } 1524 1525 /** 1526 * @throws PortalException 1527 * @deprecated As of 7.0.0, replaced by {@link 1528 com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfoInBackground( 1529 long, ExportImportConfiguration, File)} 1530 */ 1531 @Deprecated 1532 public static long importPortletInfoInBackground(long userId, 1533 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 1534 java.io.File file) 1535 throws com.liferay.portal.kernel.exception.PortalException { 1536 return getService() 1537 .importPortletInfoInBackground(userId, 1538 exportImportConfiguration, file); 1539 } 1540 1541 /** 1542 * @throws PortalException 1543 * @deprecated As of 7.0.0, replaced by {@link 1544 com.liferay.portlet.exportimport.service.ExportImportLocalService#importPortletInfoInBackground( 1545 long, long, File)} 1546 */ 1547 @Deprecated 1548 public static long importPortletInfoInBackground(long userId, 1549 long exportImportConfigurationId, java.io.File file) 1550 throws com.liferay.portal.kernel.exception.PortalException { 1551 return getService() 1552 .importPortletInfoInBackground(userId, 1553 exportImportConfigurationId, file); 1554 } 1555 1556 /** 1557 * @throws PortalException 1558 * @deprecated As of 7.0.0, with no direct replacement 1559 */ 1560 @Deprecated 1561 public static long importPortletInfoInBackground(long userId, 1562 java.lang.String taskName, long plid, long groupId, 1563 java.lang.String portletId, 1564 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1565 java.io.File file) 1566 throws com.liferay.portal.kernel.exception.PortalException { 1567 return getService() 1568 .importPortletInfoInBackground(userId, taskName, plid, 1569 groupId, portletId, parameterMap, file); 1570 } 1571 1572 /** 1573 * @throws PortalException 1574 * @deprecated As of 7.0.0, with no direct replacement 1575 */ 1576 @Deprecated 1577 public static long importPortletInfoInBackground(long userId, 1578 java.lang.String taskName, long plid, long groupId, 1579 java.lang.String portletId, 1580 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1581 java.io.InputStream is) 1582 throws com.liferay.portal.kernel.exception.PortalException { 1583 return getService() 1584 .importPortletInfoInBackground(userId, taskName, plid, 1585 groupId, portletId, parameterMap, is); 1586 } 1587 1588 /** 1589 * @throws PortalException 1590 * @deprecated As of 7.0.0, with no direct replacement 1591 */ 1592 @Deprecated 1593 public static long importPortletInfoInBackground(long userId, 1594 java.lang.String taskName, java.lang.String portletId, 1595 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1596 java.io.File file) 1597 throws com.liferay.portal.kernel.exception.PortalException { 1598 return getService() 1599 .importPortletInfoInBackground(userId, taskName, portletId, 1600 parameterMap, file); 1601 } 1602 1603 /** 1604 * @throws PortalException 1605 * @deprecated As of 7.0.0, with no direct replacement 1606 */ 1607 @Deprecated 1608 public static long importPortletInfoInBackground(long userId, 1609 java.lang.String taskName, java.lang.String portletId, 1610 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1611 java.io.InputStream is) 1612 throws com.liferay.portal.kernel.exception.PortalException { 1613 return getService() 1614 .importPortletInfoInBackground(userId, taskName, portletId, 1615 parameterMap, is); 1616 } 1617 1618 /** 1619 * Sets the layouts for the group, replacing and prioritizing all layouts of 1620 * the parent layout. 1621 * 1622 * @param groupId the primary key of the group 1623 * @param privateLayout whether the layout is private to the group 1624 * @param parentLayoutId the primary key of the parent layout 1625 * @param layoutIds the primary keys of the layouts 1626 * @param serviceContext the service context to be applied 1627 */ 1628 public static void setLayouts(long groupId, boolean privateLayout, 1629 long parentLayoutId, long[] layoutIds, 1630 com.liferay.portal.service.ServiceContext serviceContext) 1631 throws com.liferay.portal.kernel.exception.PortalException { 1632 getService() 1633 .setLayouts(groupId, privateLayout, parentLayoutId, layoutIds, 1634 serviceContext); 1635 } 1636 1637 public static void updateAsset(long userId, 1638 com.liferay.portal.model.Layout layout, long[] assetCategoryIds, 1639 java.lang.String[] assetTagNames) 1640 throws com.liferay.portal.kernel.exception.PortalException { 1641 getService().updateAsset(userId, layout, assetCategoryIds, assetTagNames); 1642 } 1643 1644 /** 1645 * Updates the friendly URL of the layout. 1646 * 1647 * @param plid the primary key of the layout 1648 * @param friendlyURL the friendly URL to be assigned 1649 * @param languageId the primary key of the language 1650 * @return the updated layout 1651 * @deprecated As of 7.0.0, replaced by {@link #updateFriendlyURL(long, 1652 long, String, String)} 1653 */ 1654 @Deprecated 1655 public static com.liferay.portal.model.Layout updateFriendlyURL(long plid, 1656 java.lang.String friendlyURL, java.lang.String languageId) 1657 throws com.liferay.portal.kernel.exception.PortalException { 1658 return getService().updateFriendlyURL(plid, friendlyURL, languageId); 1659 } 1660 1661 /** 1662 * Updates the friendly URL of the layout. 1663 * 1664 * @param userId the primary key of the user 1665 * @param plid the primary key of the layout 1666 * @param friendlyURL the friendly URL to be assigned 1667 * @param languageId the primary key of the language 1668 * @return the updated layout 1669 */ 1670 public static com.liferay.portal.model.Layout updateFriendlyURL( 1671 long userId, long plid, java.lang.String friendlyURL, 1672 java.lang.String languageId) 1673 throws com.liferay.portal.kernel.exception.PortalException { 1674 return getService() 1675 .updateFriendlyURL(userId, plid, friendlyURL, languageId); 1676 } 1677 1678 public static com.liferay.portal.model.Layout updateIconImage(long plid, 1679 byte[] bytes) 1680 throws com.liferay.portal.kernel.exception.PortalException { 1681 return getService().updateIconImage(plid, bytes); 1682 } 1683 1684 /** 1685 * Updates the layout. 1686 * 1687 * @param groupId the primary key of the group 1688 * @param privateLayout whether the layout is private to the group 1689 * @param layoutId the primary key of the layout 1690 * @param parentLayoutId the primary key of the layout's new parent 1691 layout 1692 * @param nameMap the locales and localized names to merge (optionally 1693 <code>null</code>) 1694 * @param titleMap the locales and localized titles to merge 1695 (optionally <code>null</code>) 1696 * @param descriptionMap the locales and localized descriptions to 1697 merge (optionally <code>null</code>) 1698 * @param keywordsMap the locales and localized keywords to merge 1699 (optionally <code>null</code>) 1700 * @param robotsMap the locales and localized robots to merge 1701 (optionally <code>null</code>) 1702 * @param type the layout's new type (optionally {@link 1703 LayoutConstants#TYPE_PORTLET}) 1704 * @param hidden whether the layout is hidden 1705 * @param friendlyURL the layout's new friendly URL (optionally {@link 1706 PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} or 1707 {@link 1708 PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}). The 1709 default values can be overridden in 1710 <code>portal-ext.properties</code> by specifying new values 1711 for the corresponding properties defined in {@link 1712 PropsValues}. To see how the URL is normalized when accessed, 1713 see {@link 1714 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1715 String)}. 1716 * @param iconImage whether the icon image will be updated 1717 * @param iconBytes the byte array of the layout's new icon image 1718 * @param serviceContext the service context to be applied. Can set the 1719 modification date and expando bridge attributes for the 1720 layout. For layouts that are linked to a layout prototype, 1721 attributes named <code>layoutPrototypeUuid</code> and 1722 <code>layoutPrototypeLinkedEnabled</code> can be specified to 1723 provide the unique identifier of the source prototype and a 1724 boolean to determine whether a link to it should be enabled 1725 to activate propagation of changes made to the linked page in 1726 the prototype. 1727 * @return the updated layout 1728 * @deprecated As of 6.2.0, replaced by {@link #updateLayout(long, boolean, 1729 long, long, Map, Map, Map, Map, Map, String, boolean, Map, 1730 boolean, byte[], ServiceContext)} 1731 */ 1732 @Deprecated 1733 public static com.liferay.portal.model.Layout updateLayout(long groupId, 1734 boolean privateLayout, long layoutId, long parentLayoutId, 1735 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1736 java.util.Map<java.util.Locale, java.lang.String> titleMap, 1737 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1738 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1739 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1740 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 1741 java.lang.Boolean iconImage, byte[] iconBytes, 1742 com.liferay.portal.service.ServiceContext serviceContext) 1743 throws com.liferay.portal.kernel.exception.PortalException { 1744 return getService() 1745 .updateLayout(groupId, privateLayout, layoutId, 1746 parentLayoutId, nameMap, titleMap, descriptionMap, keywordsMap, 1747 robotsMap, type, hidden, friendlyURL, iconImage, iconBytes, 1748 serviceContext); 1749 } 1750 1751 /** 1752 * Updates the layout. 1753 * 1754 * @param groupId the primary key of the group 1755 * @param privateLayout whether the layout is private to the group 1756 * @param layoutId the primary key of the layout 1757 * @param parentLayoutId the primary key of the layout's new parent layout 1758 * @param nameMap the locales and localized names to merge (optionally 1759 <code>null</code>) 1760 * @param titleMap the locales and localized titles to merge (optionally 1761 <code>null</code>) 1762 * @param descriptionMap the locales and localized descriptions to merge 1763 (optionally <code>null</code>) 1764 * @param keywordsMap the locales and localized keywords to merge 1765 (optionally <code>null</code>) 1766 * @param robotsMap the locales and localized robots to merge (optionally 1767 <code>null</code>) 1768 * @param type the layout's new type (optionally {@link 1769 LayoutConstants#TYPE_PORTLET}) 1770 * @param hidden whether the layout is hidden 1771 * @param friendlyURLMap the layout's locales and localized friendly URLs. 1772 To see how the URL is normalized when accessed, see {@link 1773 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1774 String)}. 1775 * @param iconImage whether the icon image will be updated 1776 * @param iconBytes the byte array of the layout's new icon image 1777 * @param serviceContext the service context to be applied. Can set the 1778 modification date and expando bridge attributes for the layout. 1779 For layouts that are linked to a layout prototype, attributes 1780 named <code>layoutPrototypeUuid</code> and 1781 <code>layoutPrototypeLinkedEnabled</code> can be specified to 1782 provide the unique identifier of the source prototype and a 1783 boolean to determine whether a link to it should be enabled to 1784 activate propagation of changes made to the linked page in the 1785 prototype. 1786 * @return the updated layout 1787 */ 1788 public static com.liferay.portal.model.Layout updateLayout(long groupId, 1789 boolean privateLayout, long layoutId, long parentLayoutId, 1790 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1791 java.util.Map<java.util.Locale, java.lang.String> titleMap, 1792 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1793 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1794 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1795 java.lang.String type, boolean hidden, 1796 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 1797 boolean iconImage, byte[] iconBytes, 1798 com.liferay.portal.service.ServiceContext serviceContext) 1799 throws com.liferay.portal.kernel.exception.PortalException { 1800 return getService() 1801 .updateLayout(groupId, privateLayout, layoutId, 1802 parentLayoutId, nameMap, titleMap, descriptionMap, keywordsMap, 1803 robotsMap, type, hidden, friendlyURLMap, iconImage, iconBytes, 1804 serviceContext); 1805 } 1806 1807 /** 1808 * Updates the layout replacing its type settings. 1809 * 1810 * @param groupId the primary key of the group 1811 * @param privateLayout whether the layout is private to the group 1812 * @param layoutId the primary key of the layout 1813 * @param typeSettings the settings to load the unicode properties object. 1814 See {@link UnicodeProperties #fastLoad(String)}. 1815 * @return the updated layout 1816 */ 1817 public static com.liferay.portal.model.Layout updateLayout(long groupId, 1818 boolean privateLayout, long layoutId, java.lang.String typeSettings) 1819 throws com.liferay.portal.kernel.exception.PortalException { 1820 return getService() 1821 .updateLayout(groupId, privateLayout, layoutId, typeSettings); 1822 } 1823 1824 /** 1825 * Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 1826 * 1827 * @param layout the layout 1828 * @return the layout that was updated 1829 */ 1830 public static com.liferay.portal.model.Layout updateLayout( 1831 com.liferay.portal.model.Layout layout) { 1832 return getService().updateLayout(layout); 1833 } 1834 1835 /** 1836 * Updates the look and feel of the layout. 1837 * 1838 * @param groupId the primary key of the group 1839 * @param privateLayout whether the layout is private to the group 1840 * @param layoutId the primary key of the layout 1841 * @param themeId the primary key of the layout's new theme 1842 * @param colorSchemeId the primary key of the layout's new color scheme 1843 * @param css the layout's new CSS 1844 * @param wapTheme whether the theme is for WAP browsers 1845 * @return the updated layout 1846 */ 1847 public static com.liferay.portal.model.Layout updateLookAndFeel( 1848 long groupId, boolean privateLayout, long layoutId, 1849 java.lang.String themeId, java.lang.String colorSchemeId, 1850 java.lang.String css, boolean wapTheme) 1851 throws com.liferay.portal.kernel.exception.PortalException { 1852 return getService() 1853 .updateLookAndFeel(groupId, privateLayout, layoutId, 1854 themeId, colorSchemeId, css, wapTheme); 1855 } 1856 1857 /** 1858 * Updates the name of the layout matching the group, layout ID, and 1859 * privacy. 1860 * 1861 * @param groupId the primary key of the group 1862 * @param privateLayout whether the layout is private to the group 1863 * @param layoutId the primary key of the layout 1864 * @param name the layout's new name 1865 * @param languageId the primary key of the language. For more information 1866 see {@link Locale}. 1867 * @return the updated layout 1868 */ 1869 public static com.liferay.portal.model.Layout updateName(long groupId, 1870 boolean privateLayout, long layoutId, java.lang.String name, 1871 java.lang.String languageId) 1872 throws com.liferay.portal.kernel.exception.PortalException { 1873 return getService() 1874 .updateName(groupId, privateLayout, layoutId, name, 1875 languageId); 1876 } 1877 1878 /** 1879 * Updates the name of the layout. 1880 * 1881 * @param layout the layout to be updated 1882 * @param name the layout's new name 1883 * @param languageId the primary key of the language. For more information 1884 see {@link Locale}. 1885 * @return the updated layout 1886 */ 1887 public static com.liferay.portal.model.Layout updateName( 1888 com.liferay.portal.model.Layout layout, java.lang.String name, 1889 java.lang.String languageId) 1890 throws com.liferay.portal.kernel.exception.PortalException { 1891 return getService().updateName(layout, name, languageId); 1892 } 1893 1894 /** 1895 * Updates the name of the layout matching the primary key. 1896 * 1897 * @param plid the primary key of the layout 1898 * @param name the name to be assigned 1899 * @param languageId the primary key of the language. For more information 1900 see {@link Locale}. 1901 * @return the updated layout 1902 */ 1903 public static com.liferay.portal.model.Layout updateName(long plid, 1904 java.lang.String name, java.lang.String languageId) 1905 throws com.liferay.portal.kernel.exception.PortalException { 1906 return getService().updateName(plid, name, languageId); 1907 } 1908 1909 /** 1910 * Updates the parent layout ID of the layout matching the group, layout ID, 1911 * and privacy. 1912 * 1913 * @param groupId the primary key of the group 1914 * @param privateLayout whether the layout is private to the group 1915 * @param layoutId the primary key of the layout 1916 * @param parentLayoutId the primary key to be assigned to the parent 1917 layout 1918 * @return the matching layout 1919 */ 1920 public static com.liferay.portal.model.Layout updateParentLayoutId( 1921 long groupId, boolean privateLayout, long layoutId, long parentLayoutId) 1922 throws com.liferay.portal.kernel.exception.PortalException { 1923 return getService() 1924 .updateParentLayoutId(groupId, privateLayout, layoutId, 1925 parentLayoutId); 1926 } 1927 1928 /** 1929 * Updates the parent layout ID of the layout matching the primary key. If a 1930 * layout matching the parent primary key is found, the layout ID of that 1931 * layout is assigned, otherwise {@link 1932 * LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is assigned. 1933 * 1934 * @param plid the primary key of the layout 1935 * @param parentPlid the primary key of the parent layout 1936 * @return the layout matching the primary key 1937 */ 1938 public static com.liferay.portal.model.Layout updateParentLayoutId( 1939 long plid, long parentPlid) 1940 throws com.liferay.portal.kernel.exception.PortalException { 1941 return getService().updateParentLayoutId(plid, parentPlid); 1942 } 1943 1944 /** 1945 * Updates the parent layout ID and priority of the layout. 1946 * 1947 * @param plid the primary key of the layout 1948 * @param parentPlid the primary key of the parent layout 1949 * @param priority the layout's new priority 1950 * @return the layout matching the primary key 1951 */ 1952 public static com.liferay.portal.model.Layout updateParentLayoutIdAndPriority( 1953 long plid, long parentPlid, int priority) 1954 throws com.liferay.portal.kernel.exception.PortalException { 1955 return getService() 1956 .updateParentLayoutIdAndPriority(plid, parentPlid, priority); 1957 } 1958 1959 /** 1960 * Updates the priorities of the layouts. 1961 * 1962 * @param groupId the primary key of the group 1963 * @param privateLayout whether the layout is private to the group 1964 * @throws PortalException 1965 */ 1966 public static void updatePriorities(long groupId, boolean privateLayout) 1967 throws com.liferay.portal.kernel.exception.PortalException { 1968 getService().updatePriorities(groupId, privateLayout); 1969 } 1970 1971 /** 1972 * Updates the priority of the layout matching the group, layout ID, and 1973 * privacy, setting the layout's priority based on the priorities of the 1974 * next and previous layouts. 1975 * 1976 * @param groupId the primary key of the group 1977 * @param privateLayout whether the layout is private to the group 1978 * @param layoutId the primary key of the layout 1979 * @param nextLayoutId the primary key of the next layout 1980 * @param previousLayoutId the primary key of the previous layout 1981 * @return the updated layout 1982 */ 1983 public static com.liferay.portal.model.Layout updatePriority(long groupId, 1984 boolean privateLayout, long layoutId, long nextLayoutId, 1985 long previousLayoutId) 1986 throws com.liferay.portal.kernel.exception.PortalException { 1987 return getService() 1988 .updatePriority(groupId, privateLayout, layoutId, 1989 nextLayoutId, previousLayoutId); 1990 } 1991 1992 /** 1993 * Updates the priority of the layout matching the group, layout ID, and 1994 * privacy. 1995 * 1996 * @param groupId the primary key of the group 1997 * @param privateLayout whether the layout is private to the group 1998 * @param layoutId the primary key of the layout 1999 * @param priority the layout's new priority 2000 * @return the updated layout 2001 */ 2002 public static com.liferay.portal.model.Layout updatePriority(long groupId, 2003 boolean privateLayout, long layoutId, int priority) 2004 throws com.liferay.portal.kernel.exception.PortalException { 2005 return getService() 2006 .updatePriority(groupId, privateLayout, layoutId, priority); 2007 } 2008 2009 /** 2010 * Updates the priority of the layout. 2011 * 2012 * @param layout the layout to be updated 2013 * @param priority the layout's new priority 2014 * @return the updated layout 2015 */ 2016 public static com.liferay.portal.model.Layout updatePriority( 2017 com.liferay.portal.model.Layout layout, int priority) 2018 throws com.liferay.portal.kernel.exception.PortalException { 2019 return getService().updatePriority(layout, priority); 2020 } 2021 2022 /** 2023 * Updates the priority of the layout matching the primary key. 2024 * 2025 * @param plid the primary key of the layout 2026 * @param priority the layout's new priority 2027 * @return the updated layout 2028 */ 2029 public static com.liferay.portal.model.Layout updatePriority(long plid, 2030 int priority) 2031 throws com.liferay.portal.kernel.exception.PortalException { 2032 return getService().updatePriority(plid, priority); 2033 } 2034 2035 /** 2036 * Updates the names of the portlets within scope of the group, the scope of 2037 * the layout's UUID, and the privacy. 2038 * 2039 * @param groupId the primary key of the group 2040 * @param privateLayout whether the layout is private to the group 2041 * @param layoutId the primary key of the layout whose UUID to match 2042 * @param name the new name for the portlets 2043 * @param languageId the primary key of the language 2044 * @throws PortalException 2045 * @see com.liferay.portlet.portletconfiguration.action.EditScopeAction 2046 * @deprecated As of 6.2.0, with no direct replacement 2047 */ 2048 @Deprecated 2049 public static void updateScopedPortletNames(long groupId, 2050 boolean privateLayout, long layoutId, java.lang.String name, 2051 java.lang.String languageId) 2052 throws com.liferay.portal.kernel.exception.PortalException { 2053 getService() 2054 .updateScopedPortletNames(groupId, privateLayout, layoutId, name, 2055 languageId); 2056 } 2057 2058 /** 2059 * @deprecated As of 6.2.0, with no direct replacement 2060 */ 2061 @Deprecated 2062 public static void updateScopedPortletNames(long groupId, 2063 boolean privateLayout, long layoutId, 2064 java.util.Map<java.util.Locale, java.lang.String> nameMap, 2065 java.util.List<java.util.Locale> nameMapModifiedLocales) 2066 throws com.liferay.portal.kernel.exception.PortalException { 2067 getService() 2068 .updateScopedPortletNames(groupId, privateLayout, layoutId, 2069 nameMap, nameMapModifiedLocales); 2070 } 2071 2072 /** 2073 * @throws PortalException 2074 * @deprecated As of 7.0.0, replaced by {@link 2075 com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportLayoutsFile( 2076 ExportImportConfiguration, File)} 2077 */ 2078 @Deprecated 2079 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 2080 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 2081 java.io.File file) 2082 throws com.liferay.portal.kernel.exception.PortalException { 2083 return getService() 2084 .validateImportLayoutsFile(exportImportConfiguration, file); 2085 } 2086 2087 /** 2088 * @throws PortalException 2089 * @deprecated As of 7.0.0, replaced by {@link 2090 com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportLayoutsFile( 2091 ExportImportConfiguration, InputStream)} 2092 */ 2093 @Deprecated 2094 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 2095 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 2096 java.io.InputStream inputStream) 2097 throws com.liferay.portal.kernel.exception.PortalException { 2098 return getService() 2099 .validateImportLayoutsFile(exportImportConfiguration, 2100 inputStream); 2101 } 2102 2103 /** 2104 * @throws PortalException 2105 * @deprecated As of 7.0.0, with no direct replacement 2106 */ 2107 @Deprecated 2108 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 2109 long userId, long groupId, boolean privateLayout, 2110 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 2111 java.io.File file) 2112 throws com.liferay.portal.kernel.exception.PortalException { 2113 return getService() 2114 .validateImportLayoutsFile(userId, groupId, privateLayout, 2115 parameterMap, file); 2116 } 2117 2118 /** 2119 * @throws PortalException 2120 * @deprecated As of 7.0.0, with no direct replacement 2121 */ 2122 @Deprecated 2123 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportLayoutsFile( 2124 long userId, long groupId, boolean privateLayout, 2125 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 2126 java.io.InputStream inputStream) 2127 throws com.liferay.portal.kernel.exception.PortalException { 2128 return getService() 2129 .validateImportLayoutsFile(userId, groupId, privateLayout, 2130 parameterMap, inputStream); 2131 } 2132 2133 /** 2134 * @throws PortalException 2135 * @deprecated As of 7.0.0, replaced by {@link 2136 com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportPortletInfo( 2137 ExportImportConfiguration, File)} 2138 */ 2139 @Deprecated 2140 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 2141 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 2142 java.io.File file) 2143 throws com.liferay.portal.kernel.exception.PortalException { 2144 return getService() 2145 .validateImportPortletInfo(exportImportConfiguration, file); 2146 } 2147 2148 /** 2149 * @throws PortalException 2150 * @deprecated As of 7.0.0, replaced by {@link 2151 com.liferay.portlet.exportimport.service.ExportImportLocalService#validateImportPortletInfo( 2152 ExportImportConfiguration, InputStream)} 2153 */ 2154 @Deprecated 2155 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 2156 com.liferay.portlet.exportimport.model.ExportImportConfiguration exportImportConfiguration, 2157 java.io.InputStream inputStream) 2158 throws com.liferay.portal.kernel.exception.PortalException { 2159 return getService() 2160 .validateImportPortletInfo(exportImportConfiguration, 2161 inputStream); 2162 } 2163 2164 /** 2165 * @throws PortalException 2166 * @deprecated As of 7.0.0, with no direct replacement 2167 */ 2168 @Deprecated 2169 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 2170 long userId, long plid, long groupId, java.lang.String portletId, 2171 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 2172 java.io.File file) 2173 throws com.liferay.portal.kernel.exception.PortalException { 2174 return getService() 2175 .validateImportPortletInfo(userId, plid, groupId, portletId, 2176 parameterMap, file); 2177 } 2178 2179 /** 2180 * @throws PortalException 2181 * @deprecated As of 7.0.0, with no direct replacement 2182 */ 2183 @Deprecated 2184 public static com.liferay.portlet.exportimport.lar.MissingReferences validateImportPortletInfo( 2185 long userId, long plid, long groupId, java.lang.String portletId, 2186 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 2187 java.io.InputStream inputStream) 2188 throws com.liferay.portal.kernel.exception.PortalException { 2189 return getService() 2190 .validateImportPortletInfo(userId, plid, groupId, portletId, 2191 parameterMap, inputStream); 2192 } 2193 2194 public static LayoutLocalService getService() { 2195 if (_service == null) { 2196 _service = (LayoutLocalService)PortalBeanLocatorUtil.locate(LayoutLocalService.class.getName()); 2197 2198 ReferenceRegistry.registerReference(LayoutLocalServiceUtil.class, 2199 "_service"); 2200 } 2201 2202 return _service; 2203 } 2204 2205 /** 2206 * @deprecated As of 6.2.0 2207 */ 2208 @Deprecated 2209 public void setService(LayoutLocalService service) { 2210 } 2211 2212 private static LayoutLocalService _service; 2213 }