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