001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.service; 016 017 /** 018 * <p> 019 * This class is a wrapper for {@link LayoutLocalService}. 020 * </p> 021 * 022 * @author Brian Wing Shun Chan 023 * @see LayoutLocalService 024 * @generated 025 */ 026 public class LayoutLocalServiceWrapper implements LayoutLocalService, 027 ServiceWrapper<LayoutLocalService> { 028 public LayoutLocalServiceWrapper(LayoutLocalService layoutLocalService) { 029 _layoutLocalService = layoutLocalService; 030 } 031 032 /** 033 * Adds the layout to the database. Also notifies the appropriate model listeners. 034 * 035 * @param layout the layout 036 * @return the layout that was added 037 * @throws SystemException if a system exception occurred 038 */ 039 public com.liferay.portal.model.Layout addLayout( 040 com.liferay.portal.model.Layout layout) 041 throws com.liferay.portal.kernel.exception.SystemException { 042 return _layoutLocalService.addLayout(layout); 043 } 044 045 /** 046 * Creates a new layout with the primary key. Does not add the layout to the database. 047 * 048 * @param plid the primary key for the new layout 049 * @return the new layout 050 */ 051 public com.liferay.portal.model.Layout createLayout(long plid) { 052 return _layoutLocalService.createLayout(plid); 053 } 054 055 /** 056 * Deletes the layout with the primary key from the database. Also notifies the appropriate model listeners. 057 * 058 * @param plid the primary key of the layout 059 * @return the layout that was removed 060 * @throws PortalException if a layout with the primary key could not be found 061 * @throws SystemException if a system exception occurred 062 */ 063 public com.liferay.portal.model.Layout deleteLayout(long plid) 064 throws com.liferay.portal.kernel.exception.PortalException, 065 com.liferay.portal.kernel.exception.SystemException { 066 return _layoutLocalService.deleteLayout(plid); 067 } 068 069 /** 070 * Deletes the layout from the database. Also notifies the appropriate model listeners. 071 * 072 * @param layout the layout 073 * @return the layout that was removed 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portal.model.Layout deleteLayout( 077 com.liferay.portal.model.Layout layout) 078 throws com.liferay.portal.kernel.exception.SystemException { 079 return _layoutLocalService.deleteLayout(layout); 080 } 081 082 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 083 return _layoutLocalService.dynamicQuery(); 084 } 085 086 /** 087 * Performs a dynamic query on the database and returns the matching rows. 088 * 089 * @param dynamicQuery the dynamic query 090 * @return the matching rows 091 * @throws SystemException if a system exception occurred 092 */ 093 @SuppressWarnings("rawtypes") 094 public java.util.List dynamicQuery( 095 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 096 throws com.liferay.portal.kernel.exception.SystemException { 097 return _layoutLocalService.dynamicQuery(dynamicQuery); 098 } 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query 108 * @param start the lower bound of the range of model instances 109 * @param end the upper bound of the range of model instances (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException { 117 return _layoutLocalService.dynamicQuery(dynamicQuery, start, end); 118 } 119 120 /** 121 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param dynamicQuery the dynamic query 128 * @param start the lower bound of the range of model instances 129 * @param end the upper bound of the range of model instances (not inclusive) 130 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 131 * @return the ordered range of matching rows 132 * @throws SystemException if a system exception occurred 133 */ 134 @SuppressWarnings("rawtypes") 135 public java.util.List dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end, 138 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 139 throws com.liferay.portal.kernel.exception.SystemException { 140 return _layoutLocalService.dynamicQuery(dynamicQuery, start, end, 141 orderByComparator); 142 } 143 144 /** 145 * Returns the number of rows that match the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows that match the dynamic query 149 * @throws SystemException if a system exception occurred 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 153 throws com.liferay.portal.kernel.exception.SystemException { 154 return _layoutLocalService.dynamicQueryCount(dynamicQuery); 155 } 156 157 public com.liferay.portal.model.Layout fetchLayout(long plid) 158 throws com.liferay.portal.kernel.exception.SystemException { 159 return _layoutLocalService.fetchLayout(plid); 160 } 161 162 /** 163 * Returns the layout with the primary key. 164 * 165 * @param plid the primary key of the layout 166 * @return the layout 167 * @throws PortalException if a layout with the primary key could not be found 168 * @throws SystemException if a system exception occurred 169 */ 170 public com.liferay.portal.model.Layout getLayout(long plid) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException { 173 return _layoutLocalService.getLayout(plid); 174 } 175 176 public com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException { 180 return _layoutLocalService.getPersistedModel(primaryKeyObj); 181 } 182 183 /** 184 * @param uuid the UUID of layout 185 * @param groupId the group id of the layout 186 * @param privateLayout whether the layout is private to the group 187 * @return the layout 188 * @throws PortalException if a layout with the UUID in the group and privateLayout could not be found 189 * @throws SystemException if a system exception occurred 190 */ 191 public com.liferay.portal.model.Layout getLayoutByUuidAndGroupId( 192 java.lang.String uuid, long groupId, boolean privateLayout) 193 throws com.liferay.portal.kernel.exception.PortalException, 194 com.liferay.portal.kernel.exception.SystemException { 195 return _layoutLocalService.getLayoutByUuidAndGroupId(uuid, groupId, 196 privateLayout); 197 } 198 199 /** 200 * Returns a range of all the layouts. 201 * 202 * <p> 203 * 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. 204 * </p> 205 * 206 * @param start the lower bound of the range of layouts 207 * @param end the upper bound of the range of layouts (not inclusive) 208 * @return the range of layouts 209 * @throws SystemException if a system exception occurred 210 */ 211 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 212 int start, int end) 213 throws com.liferay.portal.kernel.exception.SystemException { 214 return _layoutLocalService.getLayouts(start, end); 215 } 216 217 /** 218 * Returns the number of layouts. 219 * 220 * @return the number of layouts 221 * @throws SystemException if a system exception occurred 222 */ 223 public int getLayoutsCount() 224 throws com.liferay.portal.kernel.exception.SystemException { 225 return _layoutLocalService.getLayoutsCount(); 226 } 227 228 /** 229 * Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 230 * 231 * @param layout the layout 232 * @return the layout that was updated 233 * @throws SystemException if a system exception occurred 234 */ 235 public com.liferay.portal.model.Layout updateLayout( 236 com.liferay.portal.model.Layout layout) 237 throws com.liferay.portal.kernel.exception.SystemException { 238 return _layoutLocalService.updateLayout(layout); 239 } 240 241 /** 242 * Updates the layout in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 243 * 244 * @param layout the layout 245 * @param merge whether to merge the layout with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 246 * @return the layout that was updated 247 * @throws SystemException if a system exception occurred 248 */ 249 public com.liferay.portal.model.Layout updateLayout( 250 com.liferay.portal.model.Layout layout, boolean merge) 251 throws com.liferay.portal.kernel.exception.SystemException { 252 return _layoutLocalService.updateLayout(layout, merge); 253 } 254 255 /** 256 * Returns the Spring bean ID for this bean. 257 * 258 * @return the Spring bean ID for this bean 259 */ 260 public java.lang.String getBeanIdentifier() { 261 return _layoutLocalService.getBeanIdentifier(); 262 } 263 264 /** 265 * Sets the Spring bean ID for this bean. 266 * 267 * @param beanIdentifier the Spring bean ID for this bean 268 */ 269 public void setBeanIdentifier(java.lang.String beanIdentifier) { 270 _layoutLocalService.setBeanIdentifier(beanIdentifier); 271 } 272 273 /** 274 * Adds a layout with additional parameters. 275 * 276 * <p> 277 * This method handles the creation of the layout including its resources, 278 * metadata, and internal data structures. It is not necessary to make 279 * subsequent calls to any methods to setup default groups, resources, ... 280 * etc. 281 * </p> 282 * 283 * @param userId the primary key of the user 284 * @param groupId the primary key of the group 285 * @param privateLayout whether the layout is private to the group 286 * @param parentLayoutId the primary key of the parent layout (optionally 287 {@link 288 com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 289 * @param nameMap the layout's locales and localized names 290 * @param titleMap the layout's locales and localized titles 291 * @param descriptionMap the layout's locales and localized descriptions 292 * @param keywordsMap the layout's locales and localized keywords 293 * @param robotsMap the layout's locales and localized robots 294 * @param type the layout's type (optionally {@link 295 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The 296 possible types can be found in {@link 297 com.liferay.portal.model.LayoutConstants}. 298 * @param hidden whether the layout is hidden 299 * @param friendlyURL the layout's friendly URL (optionally {@link 300 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} 301 or {@link 302 com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). 303 The default values can be overridden in 304 <code>portal-ext.properties</code> by specifying new values for 305 the corresponding properties defined in {@link 306 com.liferay.portal.util.PropsValues}. To see how the URL is 307 normalized when accessed see {@link 308 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 309 String)}. 310 * @param serviceContext the service context. Must set the universally 311 unique identifier (UUID) for the layout. Can set the creation 312 date, modification date and the expando bridge attributes for the 313 layout. For layouts that belong to a layout set prototype, an 314 attribute named 'layoutUpdateable' can be set to specify whether 315 site administrators can modify this page within their site. For 316 layouts that are created from a layout prototype, attributes 317 named 'layoutPrototypeUuid' and 'layoutPrototypeLinkedEnabled' 318 can be specified to provide the unique identifier of the source 319 prototype and a boolean to determined whether a link to it should 320 be enabled to activate propagation of changes made to the linked 321 page in the prototype. 322 * @return the layout 323 * @throws PortalException if a group or user with the primary key could not 324 be found, or if layout values were invalid 325 * @throws SystemException if a system exception occurred 326 */ 327 public com.liferay.portal.model.Layout addLayout(long userId, long groupId, 328 boolean privateLayout, long parentLayoutId, 329 java.util.Map<java.util.Locale, java.lang.String> nameMap, 330 java.util.Map<java.util.Locale, java.lang.String> titleMap, 331 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 332 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 333 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 334 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 335 com.liferay.portal.service.ServiceContext serviceContext) 336 throws com.liferay.portal.kernel.exception.PortalException, 337 com.liferay.portal.kernel.exception.SystemException { 338 return _layoutLocalService.addLayout(userId, groupId, privateLayout, 339 parentLayoutId, nameMap, titleMap, descriptionMap, keywordsMap, 340 robotsMap, type, hidden, friendlyURL, serviceContext); 341 } 342 343 /** 344 * Adds a layout. 345 * 346 * <p> 347 * This method handles the creation of the layout including its resources, 348 * metadata, and internal data structures. It is not necessary to make 349 * subsequent calls to any methods to setup default groups, resources, ... 350 * etc. 351 * </p> 352 * 353 * @param userId the primary key of the user 354 * @param groupId the primary key of the group 355 * @param privateLayout whether the layout is private to the group 356 * @param parentLayoutId the primary key of the parent layout (optionally 357 {@link 358 com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}). 359 The possible values can be found in {@link 360 com.liferay.portal.model.LayoutConstants}. 361 * @param name the layout's name (optionally {@link 362 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_NAME} 363 or {@link 364 com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_NAME}). 365 The default values can be overridden in 366 <code>portal-ext.properties</code> by specifying new values for 367 the corresponding properties defined in {@link 368 com.liferay.portal.util.PropsValues} 369 * @param title the layout's title 370 * @param description the layout's description 371 * @param type the layout's type (optionally {@link 372 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The 373 possible types can be found in {@link 374 com.liferay.portal.model.LayoutConstants}. 375 * @param hidden whether the layout is hidden 376 * @param friendlyURL the friendly URL of the layout (optionally {@link 377 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} 378 or {@link 379 com.liferay.portal.util.PropsValues#DEFAULT_USER_PUBLIC_LAYOUT_FRIENDLY_URL}). 380 The default values can be overridden in 381 <code>portal-ext.properties</code> by specifying new values for 382 the corresponding properties defined in {@link 383 com.liferay.portal.util.PropsValues}. To see how the URL is 384 normalized when accessed see {@link 385 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 386 String)}. 387 * @param serviceContext the service context. Must set the universally 388 unique identifier (UUID) for the layout. Can set the creation 389 date and modification date for the layout. For layouts that 390 belong to a layout set prototype, an attribute named 391 'layoutUpdateable' can be set to specify whether site 392 administrators can modify this page within their site. 393 * @return the layout 394 * @throws PortalException if a group or user with the primary key could not 395 be found 396 * @throws SystemException if a system exception occurred 397 */ 398 public com.liferay.portal.model.Layout addLayout(long userId, long groupId, 399 boolean privateLayout, long parentLayoutId, java.lang.String name, 400 java.lang.String title, java.lang.String description, 401 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 402 com.liferay.portal.service.ServiceContext serviceContext) 403 throws com.liferay.portal.kernel.exception.PortalException, 404 com.liferay.portal.kernel.exception.SystemException { 405 return _layoutLocalService.addLayout(userId, groupId, privateLayout, 406 parentLayoutId, name, title, description, type, hidden, 407 friendlyURL, serviceContext); 408 } 409 410 /** 411 * Deletes the layout, its child layouts, and its associated resources. 412 * 413 * @param layout the layout 414 * @param updateLayoutSet whether the layout set's page counter needs to be 415 updated 416 * @param serviceContext the service context 417 * @throws PortalException if a portal exception occurred 418 * @throws SystemException if a system exception occurred 419 */ 420 public void deleteLayout(com.liferay.portal.model.Layout layout, 421 boolean updateLayoutSet, 422 com.liferay.portal.service.ServiceContext serviceContext) 423 throws com.liferay.portal.kernel.exception.PortalException, 424 com.liferay.portal.kernel.exception.SystemException { 425 _layoutLocalService.deleteLayout(layout, updateLayoutSet, serviceContext); 426 } 427 428 /** 429 * Deletes the layout with the primary key, also deleting the layout's child 430 * layouts, and associated resources. 431 * 432 * @param groupId the primary key of the group 433 * @param privateLayout whether the layout is private to the group 434 * @param layoutId the primary key of the layout 435 * @param serviceContext the service context 436 * @throws PortalException if a matching layout could not be found , or if 437 some other portal exception occurred 438 * @throws SystemException if a system exception occurred 439 */ 440 public void deleteLayout(long groupId, boolean privateLayout, 441 long layoutId, com.liferay.portal.service.ServiceContext serviceContext) 442 throws com.liferay.portal.kernel.exception.PortalException, 443 com.liferay.portal.kernel.exception.SystemException { 444 _layoutLocalService.deleteLayout(groupId, privateLayout, layoutId, 445 serviceContext); 446 } 447 448 /** 449 * Deletes the layout with the plid, also deleting the layout's child 450 * layouts, and associated resources. 451 * 452 * @param plid the primary key of the layout 453 * @param serviceContext the service context 454 * @throws PortalException if a layout with the primary key could not be 455 found , or if some other portal exception occurred 456 * @throws SystemException if a system exception occurred 457 */ 458 public void deleteLayout(long plid, 459 com.liferay.portal.service.ServiceContext serviceContext) 460 throws com.liferay.portal.kernel.exception.PortalException, 461 com.liferay.portal.kernel.exception.SystemException { 462 _layoutLocalService.deleteLayout(plid, serviceContext); 463 } 464 465 /** 466 * Deletes the group's private or non-private layouts, also deleting the 467 * layouts' child layouts, and associated resources. 468 * 469 * @param groupId the primary key of the group 470 * @param privateLayout whether the layout is private to the group 471 * @param serviceContext the service context 472 * @throws PortalException if a group with the primary key could not be 473 found or if a layout set for the group and privacy could not be 474 found 475 * @throws SystemException if a system exception occurred 476 */ 477 public void deleteLayouts(long groupId, boolean privateLayout, 478 com.liferay.portal.service.ServiceContext serviceContext) 479 throws com.liferay.portal.kernel.exception.PortalException, 480 com.liferay.portal.kernel.exception.SystemException { 481 _layoutLocalService.deleteLayouts(groupId, privateLayout, serviceContext); 482 } 483 484 /** 485 * Exports layouts with the primary keys and criteria as a byte array. 486 * 487 * @param groupId the primary key of the group 488 * @param privateLayout whether the layout is private to the group 489 * @param layoutIds the primary keys of the layouts to be exported 490 * @param parameterMap the mapping of parameters indicating which 491 information to export. For information on the keys used in the 492 map see {@link 493 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 494 * @param startDate the export's start date 495 * @param endDate the export's end date 496 * @return the layouts as a byte array 497 * @throws PortalException if a group or any layout with the primary key 498 could not be found, or if some other portal exception occurred 499 * @throws SystemException if a system exception occurred 500 */ 501 public byte[] exportLayouts(long groupId, boolean privateLayout, 502 long[] layoutIds, 503 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 504 java.util.Date startDate, java.util.Date endDate) 505 throws com.liferay.portal.kernel.exception.PortalException, 506 com.liferay.portal.kernel.exception.SystemException { 507 return _layoutLocalService.exportLayouts(groupId, privateLayout, 508 layoutIds, parameterMap, startDate, endDate); 509 } 510 511 /** 512 * Exports all layouts that match the criteria as a byte array. 513 * 514 * @param groupId the primary key of the group 515 * @param privateLayout whether the layout is private to the group 516 * @param parameterMap the mapping of parameters indicating which 517 information to export. For information on the keys used in the 518 map see {@link 519 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 520 * @param startDate the export's start date 521 * @param endDate the export's end date 522 * @return the layout as a byte array 523 * @throws PortalException if a group with the primary key could not be 524 found or if some other portal exception occurred 525 * @throws SystemException if a system exception occurred 526 */ 527 public byte[] exportLayouts(long groupId, boolean privateLayout, 528 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 529 java.util.Date startDate, java.util.Date endDate) 530 throws com.liferay.portal.kernel.exception.PortalException, 531 com.liferay.portal.kernel.exception.SystemException { 532 return _layoutLocalService.exportLayouts(groupId, privateLayout, 533 parameterMap, startDate, endDate); 534 } 535 536 /** 537 * Exports the layouts that match the primary keys and criteria as a file. 538 * 539 * @param groupId the primary key of the group 540 * @param privateLayout whether the layout is private to the group 541 * @param layoutIds the primary keys of the layouts to be exported 542 (optionally <code>null</code>) 543 * @param parameterMap the mapping of parameters indicating which 544 information to export. For information on the keys used in the 545 map see {@link 546 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 547 * @param startDate the export's start date 548 * @param endDate the export's end date 549 * @return the layouts as a File 550 * @throws PortalException if a group or any layout with the primary key 551 could not be found, or if some other portal exception occurred 552 * @throws SystemException if a system exception occurred 553 */ 554 public java.io.File exportLayoutsAsFile(long groupId, 555 boolean privateLayout, long[] layoutIds, 556 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 557 java.util.Date startDate, java.util.Date endDate) 558 throws com.liferay.portal.kernel.exception.PortalException, 559 com.liferay.portal.kernel.exception.SystemException { 560 return _layoutLocalService.exportLayoutsAsFile(groupId, privateLayout, 561 layoutIds, parameterMap, startDate, endDate); 562 } 563 564 /** 565 * Exports the portlet information (categories, permissions, ... etc.) as a 566 * byte array. 567 * 568 * @param plid the primary key of the layout 569 * @param groupId the primary key of the group 570 * @param portletId the primary key of the portlet 571 * @param parameterMap the mapping of parameters indicating which 572 information to export. For information on the keys used in the 573 map see {@link 574 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 575 * @param startDate the export's start date 576 * @param endDate the export's end date 577 * @return the portlet information as a byte array 578 * @throws PortalException if a group or portlet with the primary key could 579 not be found, or if some other portal exception occurred 580 * @throws SystemException if a system exception occurred 581 */ 582 public byte[] exportPortletInfo(long plid, long groupId, 583 java.lang.String portletId, 584 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 585 java.util.Date startDate, java.util.Date endDate) 586 throws com.liferay.portal.kernel.exception.PortalException, 587 com.liferay.portal.kernel.exception.SystemException { 588 return _layoutLocalService.exportPortletInfo(plid, groupId, portletId, 589 parameterMap, startDate, endDate); 590 } 591 592 /** 593 * Exports the portlet information (categories, permissions, ... etc.) as a 594 * file. 595 * 596 * @param plid the primary key of the layout 597 * @param groupId the primary key of the group 598 * @param portletId the primary key of the portlet 599 * @param parameterMap the mapping of parameters indicating which 600 information to export. For information on the keys used in the 601 map see {@link 602 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 603 * @param startDate the export's start date 604 * @param endDate the export's end date 605 * @return the portlet information as a file 606 * @throws PortalException if a group or portlet with the primary key could 607 not be found, or if some other portal exception occurred 608 * @throws SystemException if a system exception occurred 609 */ 610 public java.io.File exportPortletInfoAsFile(long plid, long groupId, 611 java.lang.String portletId, 612 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 613 java.util.Date startDate, java.util.Date endDate) 614 throws com.liferay.portal.kernel.exception.PortalException, 615 com.liferay.portal.kernel.exception.SystemException { 616 return _layoutLocalService.exportPortletInfoAsFile(plid, groupId, 617 portletId, parameterMap, startDate, endDate); 618 } 619 620 public com.liferay.portal.model.Layout fetchFirstLayout(long groupId, 621 boolean privateLayout, long parentLayoutId) 622 throws com.liferay.portal.kernel.exception.SystemException { 623 return _layoutLocalService.fetchFirstLayout(groupId, privateLayout, 624 parentLayoutId); 625 } 626 627 /** 628 * @param uuid the universally unique identifier of the scope layout 629 * @param groupId the primary key of the group 630 * @param privateLayout whether the layout is private to the group 631 * @return the layout, or <code>null</code> if a matching layout could not 632 be found 633 * @throws SystemException if a system exception occurred 634 */ 635 public com.liferay.portal.model.Layout fetchLayoutByUuidAndGroupId( 636 java.lang.String uuid, long groupId, boolean privateLayout) 637 throws com.liferay.portal.kernel.exception.SystemException { 638 return _layoutLocalService.fetchLayoutByUuidAndGroupId(uuid, groupId, 639 privateLayout); 640 } 641 642 /** 643 * Returns the primary key of the default layout for the group 644 * 645 * @param groupId the primary key of the group 646 * @return the primary key of the default layout for the group (optionally 647 {@link com.liferay.portal.model.LayoutConstants#DEFAULT_PLID}) 648 * @throws SystemException if a system exception occurred 649 */ 650 public long getDefaultPlid(long groupId) 651 throws com.liferay.portal.kernel.exception.SystemException { 652 return _layoutLocalService.getDefaultPlid(groupId); 653 } 654 655 /** 656 * Returns primary key of the matching default layout for the group 657 * 658 * @param groupId the primary key of the group 659 * @param privateLayout whether the layout is private to the group 660 * @return the primary key of the default layout for the group; {@link 661 com.liferay.portal.model.LayoutConstants#DEFAULT_PLID}) otherwise 662 * @throws SystemException if a system exception occurred 663 */ 664 public long getDefaultPlid(long groupId, boolean privateLayout) 665 throws com.liferay.portal.kernel.exception.SystemException { 666 return _layoutLocalService.getDefaultPlid(groupId, privateLayout); 667 } 668 669 /** 670 * Returns primary key of the default portlet layout for the group 671 * 672 * @param groupId the primary key of the group 673 * @param privateLayout whether the layout is private to the group 674 * @param portletId the primary key of the portlet 675 * @return the primary key of the default portlet layout for the group; 676 {@link com.liferay.portal.model.LayoutConstants#DEFAULT_PLID} 677 otherwise 678 * @throws PortalException if a portlet with the primary key could not be 679 found 680 * @throws SystemException if a system exception occurred 681 */ 682 public long getDefaultPlid(long groupId, boolean privateLayout, 683 java.lang.String portletId) 684 throws com.liferay.portal.kernel.exception.PortalException, 685 com.liferay.portal.kernel.exception.SystemException { 686 return _layoutLocalService.getDefaultPlid(groupId, privateLayout, 687 portletId); 688 } 689 690 /** 691 * Returns the layout for the friendly URL 692 * 693 * @param groupId the primary key of the group 694 * @param privateLayout whether the layout is private to the group 695 * @param friendlyURL the friendly URL of the layout 696 * @return the layout for the friendly URL 697 * @throws PortalException if the friendly URL is <code>null</code> or a 698 matching layout could not be found 699 * @throws SystemException if a system exception occurred 700 */ 701 public com.liferay.portal.model.Layout getFriendlyURLLayout(long groupId, 702 boolean privateLayout, java.lang.String friendlyURL) 703 throws com.liferay.portal.kernel.exception.PortalException, 704 com.liferay.portal.kernel.exception.SystemException { 705 return _layoutLocalService.getFriendlyURLLayout(groupId, privateLayout, 706 friendlyURL); 707 } 708 709 /** 710 * Returns the layout matching the primary key, group, and privacy; throws a 711 * {@link com.liferay.portal.NoSuchLayoutException} otherwise. 712 * 713 * @param groupId the primary key of the group 714 * @param privateLayout whether the layout is private to the group 715 * @param layoutId the primary key of the layout 716 * @return the matching layout 717 * @throws PortalException if a matching layout could not be found 718 * @throws SystemException if a system exception occurred 719 */ 720 public com.liferay.portal.model.Layout getLayout(long groupId, 721 boolean privateLayout, long layoutId) 722 throws com.liferay.portal.kernel.exception.PortalException, 723 com.liferay.portal.kernel.exception.SystemException { 724 return _layoutLocalService.getLayout(groupId, privateLayout, layoutId); 725 } 726 727 /** 728 * Returns the layout for the icon image; throws a {@link 729 * com.liferay.portal.NoSuchLayoutException} otherwise. 730 * 731 * @param iconImageId the primary key of the icon image 732 * @return Returns the layout for the icon image 733 * @throws PortalException if an icon image with the primary key could not 734 be found 735 * @throws SystemException if a system exception occurred 736 */ 737 public com.liferay.portal.model.Layout getLayoutByIconImageId( 738 long iconImageId) 739 throws com.liferay.portal.kernel.exception.PortalException, 740 com.liferay.portal.kernel.exception.SystemException { 741 return _layoutLocalService.getLayoutByIconImageId(iconImageId); 742 } 743 744 /** 745 * Returns all the layouts belonging to the group. 746 * 747 * @param groupId the primary key of the group 748 * @param privateLayout whether the layout is private to the group 749 * @return the matching layouts, or <code>null</code> if no matches were 750 found 751 * @throws SystemException if a system exception occurred 752 */ 753 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 754 long groupId, boolean privateLayout) 755 throws com.liferay.portal.kernel.exception.SystemException { 756 return _layoutLocalService.getLayouts(groupId, privateLayout); 757 } 758 759 /** 760 * Returns all the layouts belonging to the group that are children of the 761 * parent layout. 762 * 763 * @param groupId the primary key of the group 764 * @param privateLayout whether the layout is private to the group 765 * @param parentLayoutId the primary key of the parent layout 766 * @return the matching layouts, or <code>null</code> if no matches were 767 found 768 * @throws SystemException if a system exception occurred 769 */ 770 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 771 long groupId, boolean privateLayout, long parentLayoutId) 772 throws com.liferay.portal.kernel.exception.SystemException { 773 return _layoutLocalService.getLayouts(groupId, privateLayout, 774 parentLayoutId); 775 } 776 777 /** 778 * Returns a range of all the layouts belonging to the group that are 779 * children of the parent layout. 780 * 781 * <p> 782 * Useful when paginating results. Returns a maximum of <code>end - 783 * start</code> instances. <code>start</code> and <code>end</code> are not 784 * primary keys, they are indexes in the result set. Thus, <code>0</code> 785 * refers to the first result in the set. Setting both <code>start</code> 786 * and <code>end</code> to {@link 787 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 788 * result set. 789 * </p> 790 * 791 * @param groupId the primary key of the group 792 * @param privateLayout whether the layout is private to the group 793 * @param parentLayoutId the primary key of the parent layout 794 * @param incomplete whether the layout is incomplete 795 * @param start the lower bound of the range of layouts 796 * @param end the upper bound of the range of layouts (not inclusive) 797 * @return the matching layouts, or <code>null</code> if no matches were 798 found 799 * @throws SystemException if a system exception occurred 800 */ 801 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 802 long groupId, boolean privateLayout, long parentLayoutId, 803 boolean incomplete, int start, int end) 804 throws com.liferay.portal.kernel.exception.SystemException { 805 return _layoutLocalService.getLayouts(groupId, privateLayout, 806 parentLayoutId, incomplete, start, end); 807 } 808 809 /** 810 * Returns all the layouts that match the layout IDs and belong to the 811 * group. 812 * 813 * @param groupId the primary key of the group 814 * @param privateLayout whether the layout is private to the group 815 * @param layoutIds the primary keys of the layouts 816 * @return the matching layouts, or <code>null</code> if no matches were 817 found 818 * @throws PortalException if a group or layout with the primary key could 819 not be found 820 * @throws SystemException if a system exception occurred 821 */ 822 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 823 long groupId, boolean privateLayout, long[] layoutIds) 824 throws com.liferay.portal.kernel.exception.PortalException, 825 com.liferay.portal.kernel.exception.SystemException { 826 return _layoutLocalService.getLayouts(groupId, privateLayout, layoutIds); 827 } 828 829 /** 830 * Returns all the layouts that match the type and belong to the group. 831 * 832 * @param groupId the primary key of the group 833 * @param privateLayout whether the layout is private to the group 834 * @param type the type of the layouts (optionally {@link 835 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 836 * @return the matching layouts, or <code>null</code> if no matches were 837 found 838 * @throws SystemException if a system exception occurred 839 */ 840 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 841 long groupId, boolean privateLayout, java.lang.String type) 842 throws com.liferay.portal.kernel.exception.SystemException { 843 return _layoutLocalService.getLayouts(groupId, privateLayout, type); 844 } 845 846 /** 847 * Returns the layout references for all the layouts that belong to the 848 * company and belong to the portlet that matches the preferences. 849 * 850 * @param companyId the primary key of the company 851 * @param portletId the primary key of the portlet 852 * @param preferencesKey the portlet's preference key 853 * @param preferencesValue the portlet's preference value 854 * @return the layout references of the matching layouts 855 * @throws SystemException if a system exception occurred 856 */ 857 public com.liferay.portal.model.LayoutReference[] getLayouts( 858 long companyId, java.lang.String portletId, 859 java.lang.String preferencesKey, java.lang.String preferencesValue) 860 throws com.liferay.portal.kernel.exception.SystemException { 861 return _layoutLocalService.getLayouts(companyId, portletId, 862 preferencesKey, preferencesValue); 863 } 864 865 public int getLayoutsByLayoutPrototypeUuidCount( 866 java.lang.String layoutPrototypeUuid) 867 throws com.liferay.portal.kernel.exception.SystemException { 868 return _layoutLocalService.getLayoutsByLayoutPrototypeUuidCount(layoutPrototypeUuid); 869 } 870 871 public int getLayoutsCount(com.liferay.portal.model.Group group, 872 boolean privateLayout) 873 throws com.liferay.portal.kernel.exception.PortalException, 874 com.liferay.portal.kernel.exception.SystemException { 875 return _layoutLocalService.getLayoutsCount(group, privateLayout); 876 } 877 878 public int getLayoutsCount(com.liferay.portal.model.Group group, 879 boolean privateLayout, boolean includeUserGroups) 880 throws com.liferay.portal.kernel.exception.PortalException, 881 com.liferay.portal.kernel.exception.SystemException { 882 return _layoutLocalService.getLayoutsCount(group, privateLayout, 883 includeUserGroups); 884 } 885 886 public int getLayoutsCount(com.liferay.portal.model.User user, 887 boolean privateLayout) 888 throws com.liferay.portal.kernel.exception.PortalException, 889 com.liferay.portal.kernel.exception.SystemException { 890 return _layoutLocalService.getLayoutsCount(user, privateLayout); 891 } 892 893 public int getLayoutsCount(com.liferay.portal.model.User user, 894 boolean privateLayout, boolean includeUserGroups) 895 throws com.liferay.portal.kernel.exception.PortalException, 896 com.liferay.portal.kernel.exception.SystemException { 897 return _layoutLocalService.getLayoutsCount(user, privateLayout, 898 includeUserGroups); 899 } 900 901 /** 902 * Returns the primary key to use for the next layout. 903 * 904 * @param groupId the primary key of the group 905 * @param privateLayout whether the layout is private to the group 906 * @return the primary key to use for the next layout 907 * @throws SystemException if a system exception occurred 908 */ 909 public long getNextLayoutId(long groupId, boolean privateLayout) 910 throws com.liferay.portal.kernel.exception.SystemException { 911 return _layoutLocalService.getNextLayoutId(groupId, privateLayout); 912 } 913 914 /** 915 * Returns all the layouts whose friendly URLs are <code>null</code> 916 * 917 * @return all the layouts whose friendly URLs are <code>null</code> 918 * @throws SystemException if a system exception occurred 919 */ 920 public java.util.List<com.liferay.portal.model.Layout> getNullFriendlyURLLayouts() 921 throws com.liferay.portal.kernel.exception.SystemException { 922 return _layoutLocalService.getNullFriendlyURLLayouts(); 923 } 924 925 /** 926 * Returns all the layouts within scope of the group 927 * 928 * @param groupId the primary key of the group 929 * @param privateLayout whether the layout is private to the group 930 * @return the layouts within scope of the group 931 * @throws SystemException if a system exception occurred 932 */ 933 public java.util.List<com.liferay.portal.model.Layout> getScopeGroupLayouts( 934 long groupId, boolean privateLayout) 935 throws com.liferay.portal.kernel.exception.SystemException { 936 return _layoutLocalService.getScopeGroupLayouts(groupId, privateLayout); 937 } 938 939 public boolean hasLayouts(com.liferay.portal.model.Group group, 940 boolean privateLayout) 941 throws com.liferay.portal.kernel.exception.PortalException, 942 com.liferay.portal.kernel.exception.SystemException { 943 return _layoutLocalService.hasLayouts(group, privateLayout); 944 } 945 946 public boolean hasLayouts(com.liferay.portal.model.Group group, 947 boolean privateLayout, boolean includeUserGroups) 948 throws com.liferay.portal.kernel.exception.PortalException, 949 com.liferay.portal.kernel.exception.SystemException { 950 return _layoutLocalService.hasLayouts(group, privateLayout, 951 includeUserGroups); 952 } 953 954 /** 955 * Returns <code>true</code> if the group has any layouts; 956 * <code>false</code> otherwise. 957 * 958 * @param groupId the primary key of the group 959 * @param privateLayout whether the layout is private to the group 960 * @param parentLayoutId the primary key of the parent layout 961 * @return <code>true</code> if the group has any layouts; 962 <code>false</code> otherwise 963 * @throws SystemException if a system exception occurred 964 */ 965 public boolean hasLayouts(long groupId, boolean privateLayout, 966 long parentLayoutId) 967 throws com.liferay.portal.kernel.exception.SystemException { 968 return _layoutLocalService.hasLayouts(groupId, privateLayout, 969 parentLayoutId); 970 } 971 972 public boolean hasLayouts(com.liferay.portal.model.User user, 973 boolean privateLayout) 974 throws com.liferay.portal.kernel.exception.PortalException, 975 com.liferay.portal.kernel.exception.SystemException { 976 return _layoutLocalService.hasLayouts(user, privateLayout); 977 } 978 979 public boolean hasLayouts(com.liferay.portal.model.User user, 980 boolean privateLayout, boolean includeUserGroups) 981 throws com.liferay.portal.kernel.exception.PortalException, 982 com.liferay.portal.kernel.exception.SystemException { 983 return _layoutLocalService.hasLayouts(user, privateLayout, 984 includeUserGroups); 985 } 986 987 public boolean hasLayoutSetPrototypeLayout(long layoutSetPrototypeId, 988 java.lang.String layoutUuid) 989 throws com.liferay.portal.kernel.exception.PortalException, 990 com.liferay.portal.kernel.exception.SystemException { 991 return _layoutLocalService.hasLayoutSetPrototypeLayout(layoutSetPrototypeId, 992 layoutUuid); 993 } 994 995 public boolean hasLayoutSetPrototypeLayout( 996 java.lang.String layoutSetPrototypeUuid, java.lang.String layoutUuid) 997 throws com.liferay.portal.kernel.exception.PortalException, 998 com.liferay.portal.kernel.exception.SystemException { 999 return _layoutLocalService.hasLayoutSetPrototypeLayout(layoutSetPrototypeUuid, 1000 layoutUuid); 1001 } 1002 1003 /** 1004 * Imports the layouts from the byte array. 1005 * 1006 * @param userId the primary key of the user 1007 * @param groupId the primary key of the group 1008 * @param privateLayout whether the layout is private to the group 1009 * @param parameterMap the mapping of parameters indicating which 1010 information will be imported. For information on the keys used in 1011 the map see {@link 1012 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 1013 * @param bytes the byte array with the data 1014 * @throws PortalException if a group or user with the primary key could not 1015 be found, or if some other portal exception occurred 1016 * @throws SystemException if a system exception occurred 1017 * @see com.liferay.portal.lar.LayoutImporter 1018 */ 1019 public void importLayouts(long userId, long groupId, boolean privateLayout, 1020 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1021 byte[] bytes) 1022 throws com.liferay.portal.kernel.exception.PortalException, 1023 com.liferay.portal.kernel.exception.SystemException { 1024 _layoutLocalService.importLayouts(userId, groupId, privateLayout, 1025 parameterMap, bytes); 1026 } 1027 1028 /** 1029 * Imports the layouts from the file. 1030 * 1031 * @param userId the primary key of the user 1032 * @param groupId the primary key of the group 1033 * @param privateLayout whether the layout is private to the group 1034 * @param parameterMap the mapping of parameters indicating which 1035 information will be imported. For information on the keys used in 1036 the map see {@link 1037 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 1038 * @param file the LAR file with the data 1039 * @throws PortalException if a group or user with the primary key could not 1040 be found, or if some other portal exception occurred 1041 * @throws SystemException if a system exception occurred 1042 * @see com.liferay.portal.lar.LayoutImporter 1043 */ 1044 public void importLayouts(long userId, long groupId, boolean privateLayout, 1045 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1046 java.io.File file) 1047 throws com.liferay.portal.kernel.exception.PortalException, 1048 com.liferay.portal.kernel.exception.SystemException { 1049 _layoutLocalService.importLayouts(userId, groupId, privateLayout, 1050 parameterMap, file); 1051 } 1052 1053 /** 1054 * Imports the layouts from the input stream. 1055 * 1056 * @param userId the primary key of the user 1057 * @param groupId the primary key of the group 1058 * @param privateLayout whether the layout is private to the group 1059 * @param parameterMap the mapping of parameters indicating which 1060 information will be imported. For information on the keys used in 1061 the map see {@link 1062 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 1063 * @param is the input stream 1064 * @throws PortalException if a group or user with the primary key could not 1065 be found, or if some other portal exception occurred 1066 * @throws SystemException if a system exception occurred 1067 * @see com.liferay.portal.lar.LayoutImporter 1068 */ 1069 public void importLayouts(long userId, long groupId, boolean privateLayout, 1070 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1071 java.io.InputStream is) 1072 throws com.liferay.portal.kernel.exception.PortalException, 1073 com.liferay.portal.kernel.exception.SystemException { 1074 _layoutLocalService.importLayouts(userId, groupId, privateLayout, 1075 parameterMap, is); 1076 } 1077 1078 /** 1079 * Imports the portlet information (categories, permissions, ... etc.) from 1080 * the file. 1081 * 1082 * @param userId the primary key of the user 1083 * @param plid the primary key of the target layout 1084 * @param groupId the primary key of the target group 1085 * @param portletId the primary key of the portlet 1086 * @param parameterMap the mapping of parameters indicating which 1087 information will be imported. For information on the keys used in 1088 the map see {@link 1089 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 1090 * @param file the LAR file with the data 1091 * @throws PortalException if a group, layout, portlet or user with the 1092 primary key could not be found 1093 * @throws SystemException if a system exception occurred 1094 */ 1095 public void importPortletInfo(long userId, long plid, long groupId, 1096 java.lang.String portletId, 1097 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1098 java.io.File file) 1099 throws com.liferay.portal.kernel.exception.PortalException, 1100 com.liferay.portal.kernel.exception.SystemException { 1101 _layoutLocalService.importPortletInfo(userId, plid, groupId, portletId, 1102 parameterMap, file); 1103 } 1104 1105 /** 1106 * Imports the portlet information (categories, permissions, ... etc.) from 1107 * the input stream. 1108 * 1109 * @param userId the primary key of the user 1110 * @param plid the primary key of the layout 1111 * @param groupId the primary key of the group 1112 * @param portletId the primary key of the portlet 1113 * @param parameterMap the mapping of parameters indicating which 1114 information will be imported. For information on the keys used in 1115 the map see {@link 1116 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 1117 * @param is the input stream 1118 * @throws PortalException if a group, portlet, layout or user with the 1119 primary key could not be found 1120 * @throws SystemException if a system exception occurred 1121 */ 1122 public void importPortletInfo(long userId, long plid, long groupId, 1123 java.lang.String portletId, 1124 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1125 java.io.InputStream is) 1126 throws com.liferay.portal.kernel.exception.PortalException, 1127 com.liferay.portal.kernel.exception.SystemException { 1128 _layoutLocalService.importPortletInfo(userId, plid, groupId, portletId, 1129 parameterMap, is); 1130 } 1131 1132 /** 1133 * Sets the layouts for the group, replacing and prioritizing all layouts of 1134 * the parent layout. 1135 * 1136 * @param groupId the primary key of the group 1137 * @param privateLayout whether the layout is private to the group 1138 * @param parentLayoutId the primary key of the parent layout 1139 * @param layoutIds the primary keys of the layouts 1140 * @param serviceContext the service context 1141 * @throws PortalException if a group or layout with the primary key could 1142 not be found, if no layouts were specified, if the first layout 1143 was not page-able, if the first layout was hidden, or if some 1144 other portal exception occurred 1145 * @throws SystemException if a system exception occurred 1146 */ 1147 public void setLayouts(long groupId, boolean privateLayout, 1148 long parentLayoutId, long[] layoutIds, 1149 com.liferay.portal.service.ServiceContext serviceContext) 1150 throws com.liferay.portal.kernel.exception.PortalException, 1151 com.liferay.portal.kernel.exception.SystemException { 1152 _layoutLocalService.setLayouts(groupId, privateLayout, parentLayoutId, 1153 layoutIds, serviceContext); 1154 } 1155 1156 /** 1157 * Updates the friendly URL of the layout. 1158 * 1159 * @param plid the primary key of the layout 1160 * @param friendlyURL the friendly URL to be assigned 1161 * @return the updated layout 1162 * @throws PortalException if a group or layout with the primary key could 1163 not be found 1164 * @throws SystemException if a system exception occurred 1165 */ 1166 public com.liferay.portal.model.Layout updateFriendlyURL(long plid, 1167 java.lang.String friendlyURL) 1168 throws com.liferay.portal.kernel.exception.PortalException, 1169 com.liferay.portal.kernel.exception.SystemException { 1170 return _layoutLocalService.updateFriendlyURL(plid, friendlyURL); 1171 } 1172 1173 /** 1174 * Updates the layout. 1175 * 1176 * @param groupId the primary key of the group 1177 * @param privateLayout whether the layout is private to the group 1178 * @param layoutId the primary key of the layout 1179 * @param parentLayoutId the primary key of the layout's new parent layout 1180 * @param nameMap the locales and localized names to merge (optionally 1181 <code>null</code>) 1182 * @param titleMap the locales and localized titles to merge (optionally 1183 <code>null</code>) 1184 * @param descriptionMap the locales and localized descriptions to merge 1185 (optionally <code>null</code>) 1186 * @param keywordsMap the locales and localized keywords to merge 1187 (optionally <code>null</code>) 1188 * @param robotsMap the locales and localized robots to merge (optionally 1189 <code>null</code>) 1190 * @param type the layout's new type (optionally {@link 1191 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 1192 * @param hidden whether the layout is hidden 1193 * @param friendlyURL the layout's new friendly URL (optionally {@link 1194 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL} 1195 or {@link 1196 com.liferay.portal.util.PropsValues#DEFAULT_USER_PRIVATE_LAYOUT_FRIENDLY_URL}). 1197 The default values can be overridden in 1198 <code>portal-ext.properties</code> by specifying new values for 1199 the corresponding properties defined in {@link 1200 com.liferay.portal.util.PropsValues}. To see how the URL is 1201 normalized when accessed see {@link 1202 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 1203 String)}. 1204 * @param iconImage whether the icon image will be updated 1205 * @param iconBytes the byte array of the layout's new icon image 1206 * @param serviceContext the service context. Can set the modification date 1207 and expando bridge attributes for the layout. For layouts that 1208 are linked to a layout prototype, attributes named 1209 'layoutPrototypeUuid' and 'layoutPrototypeLinkedEnabled' can be 1210 specified to provide the unique identifier of the source 1211 prototype and a boolean to determined whether a link to it should 1212 be enabled to activate propagation of changes made to the linked 1213 page in the prototype. 1214 * @return the updated layout 1215 * @throws PortalException if a group or layout with the primary key could 1216 not be found, if a unique friendly URL could not be generated, if 1217 a valid parent layout ID to use could not be found, or if the 1218 layout parameters were invalid 1219 * @throws SystemException if a system exception occurred 1220 */ 1221 public com.liferay.portal.model.Layout updateLayout(long groupId, 1222 boolean privateLayout, long layoutId, long parentLayoutId, 1223 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1224 java.util.Map<java.util.Locale, java.lang.String> titleMap, 1225 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1226 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 1227 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 1228 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 1229 java.lang.Boolean iconImage, byte[] iconBytes, 1230 com.liferay.portal.service.ServiceContext serviceContext) 1231 throws com.liferay.portal.kernel.exception.PortalException, 1232 com.liferay.portal.kernel.exception.SystemException { 1233 return _layoutLocalService.updateLayout(groupId, privateLayout, 1234 layoutId, parentLayoutId, nameMap, titleMap, descriptionMap, 1235 keywordsMap, robotsMap, type, hidden, friendlyURL, iconImage, 1236 iconBytes, serviceContext); 1237 } 1238 1239 /** 1240 * Updates the layout replacing its type settings. 1241 * 1242 * @param groupId the primary key of the group 1243 * @param privateLayout whether the layout is private to the group 1244 * @param layoutId the primary key of the layout 1245 * @param typeSettings the settings to load the unicode properties object. 1246 See {@link com.liferay.portal.kernel.util.UnicodeProperties 1247 #fastLoad(String)}. 1248 * @return the updated layout 1249 * @throws PortalException if a matching layout could not be found 1250 * @throws SystemException if a system exception occurred 1251 */ 1252 public com.liferay.portal.model.Layout updateLayout(long groupId, 1253 boolean privateLayout, long layoutId, java.lang.String typeSettings) 1254 throws com.liferay.portal.kernel.exception.PortalException, 1255 com.liferay.portal.kernel.exception.SystemException { 1256 return _layoutLocalService.updateLayout(groupId, privateLayout, 1257 layoutId, typeSettings); 1258 } 1259 1260 /** 1261 * Updates the look and feel of the layout. 1262 * 1263 * @param groupId the primary key of the group 1264 * @param privateLayout whether the layout is private to the group 1265 * @param layoutId the primary key of the layout 1266 * @param themeId the primary key of the layout's new theme 1267 * @param colorSchemeId the primary key of the layout's new color scheme 1268 * @param css the layout's new CSS 1269 * @param wapTheme whether the theme is for WAP browsers 1270 * @return the updated layout 1271 * @throws PortalException if a matching layout could not be found 1272 * @throws SystemException if a system exception occurred 1273 */ 1274 public com.liferay.portal.model.Layout updateLookAndFeel(long groupId, 1275 boolean privateLayout, long layoutId, java.lang.String themeId, 1276 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 1277 throws com.liferay.portal.kernel.exception.PortalException, 1278 com.liferay.portal.kernel.exception.SystemException { 1279 return _layoutLocalService.updateLookAndFeel(groupId, privateLayout, 1280 layoutId, themeId, colorSchemeId, css, wapTheme); 1281 } 1282 1283 /** 1284 * Updates the name of the layout. 1285 * 1286 * @param layout the layout to be updated 1287 * @param name the layout's new name 1288 * @param languageId the primary key of the language. For more information 1289 see {@link java.util.Locale}. 1290 * @return the updated layout 1291 * @throws PortalException if the new name was <code>null</code> 1292 * @throws SystemException if a system exception occurred 1293 */ 1294 public com.liferay.portal.model.Layout updateName( 1295 com.liferay.portal.model.Layout layout, java.lang.String name, 1296 java.lang.String languageId) 1297 throws com.liferay.portal.kernel.exception.PortalException, 1298 com.liferay.portal.kernel.exception.SystemException { 1299 return _layoutLocalService.updateName(layout, name, languageId); 1300 } 1301 1302 /** 1303 * Updates the name of the layout matching the group, layout ID, and 1304 * privacy. 1305 * 1306 * @param groupId the primary key of the group 1307 * @param privateLayout whether the layout is private to the group 1308 * @param layoutId the primary key of the layout 1309 * @param name the layout's new name 1310 * @param languageId the primary key of the language. For more information 1311 see {@link java.util.Locale}. 1312 * @return the updated layout 1313 * @throws PortalException if a matching layout could not be found or if the 1314 new name was <code>null</code> 1315 * @throws SystemException if a system exception occurred 1316 */ 1317 public com.liferay.portal.model.Layout updateName(long groupId, 1318 boolean privateLayout, long layoutId, java.lang.String name, 1319 java.lang.String languageId) 1320 throws com.liferay.portal.kernel.exception.PortalException, 1321 com.liferay.portal.kernel.exception.SystemException { 1322 return _layoutLocalService.updateName(groupId, privateLayout, layoutId, 1323 name, languageId); 1324 } 1325 1326 /** 1327 * Updates the name of the layout matching the primary key. 1328 * 1329 * @param plid the primary key of the layout 1330 * @param name the name to be assigned 1331 * @param languageId the primary key of the language. For more information 1332 see {@link java.util.Locale}. 1333 * @return the updated layout 1334 * @throws PortalException if a layout with the primary key could not be 1335 found or if the name was <code>null</code> 1336 * @throws SystemException if a system exception occurred 1337 */ 1338 public com.liferay.portal.model.Layout updateName(long plid, 1339 java.lang.String name, java.lang.String languageId) 1340 throws com.liferay.portal.kernel.exception.PortalException, 1341 com.liferay.portal.kernel.exception.SystemException { 1342 return _layoutLocalService.updateName(plid, name, languageId); 1343 } 1344 1345 /** 1346 * Updates the parent layout ID of the layout matching the group, layout ID, 1347 * and privacy. 1348 * 1349 * @param groupId the primary key of the group 1350 * @param privateLayout whether the layout is private to the group 1351 * @param layoutId the primary key of the layout 1352 * @param parentLayoutId the primary key to be assigned to the parent 1353 layout 1354 * @return the matching layout 1355 * @throws PortalException if a valid parent layout ID to use could not be 1356 found or if a matching layout could not be found 1357 * @throws SystemException if a system exception occurred 1358 */ 1359 public com.liferay.portal.model.Layout updateParentLayoutId(long groupId, 1360 boolean privateLayout, long layoutId, long parentLayoutId) 1361 throws com.liferay.portal.kernel.exception.PortalException, 1362 com.liferay.portal.kernel.exception.SystemException { 1363 return _layoutLocalService.updateParentLayoutId(groupId, privateLayout, 1364 layoutId, parentLayoutId); 1365 } 1366 1367 /** 1368 * Updates the parent layout ID of the layout matching the primary key. If a 1369 * layout matching the parent primary key is found, the layout ID of that 1370 * layout is assigned, otherwise {@link 1371 * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is 1372 * assigned. 1373 * 1374 * @param plid the primary key of the layout 1375 * @param parentPlid the primary key of the parent layout 1376 * @return the layout matching the primary key 1377 * @throws PortalException if a layout with the primary key could not be 1378 found or if a valid parent layout ID to use could not be found 1379 * @throws SystemException if a system exception occurred 1380 */ 1381 public com.liferay.portal.model.Layout updateParentLayoutId(long plid, 1382 long parentPlid) 1383 throws com.liferay.portal.kernel.exception.PortalException, 1384 com.liferay.portal.kernel.exception.SystemException { 1385 return _layoutLocalService.updateParentLayoutId(plid, parentPlid); 1386 } 1387 1388 /** 1389 * Updates the priorities of the layouts. 1390 * 1391 * @param groupId the primary key of the group 1392 * @param privateLayout whether the layout is private to the group 1393 * @throws PortalException if a matching layout could not be found 1394 * @throws SystemException if a system exception occurred 1395 */ 1396 public void updatePriorities(long groupId, boolean privateLayout) 1397 throws com.liferay.portal.kernel.exception.PortalException, 1398 com.liferay.portal.kernel.exception.SystemException { 1399 _layoutLocalService.updatePriorities(groupId, privateLayout); 1400 } 1401 1402 /** 1403 * Updates the priority of the layout. 1404 * 1405 * @param layout the layout to be updated 1406 * @param priority the layout's new priority 1407 * @return the updated layout 1408 * @throws SystemException if a system exception occurred 1409 */ 1410 public com.liferay.portal.model.Layout updatePriority( 1411 com.liferay.portal.model.Layout layout, int priority) 1412 throws com.liferay.portal.kernel.exception.SystemException { 1413 return _layoutLocalService.updatePriority(layout, priority); 1414 } 1415 1416 /** 1417 * Updates the priority of the layout matching the group, layout ID, and 1418 * privacy. 1419 * 1420 * @param groupId the primary key of the group 1421 * @param privateLayout whether the layout is private to the group 1422 * @param layoutId the primary key of the layout 1423 * @param priority the layout's new priority 1424 * @return the updated layout 1425 * @throws PortalException if a matching layout could not be found 1426 * @throws SystemException if a system exception occurred 1427 */ 1428 public com.liferay.portal.model.Layout updatePriority(long groupId, 1429 boolean privateLayout, long layoutId, int priority) 1430 throws com.liferay.portal.kernel.exception.PortalException, 1431 com.liferay.portal.kernel.exception.SystemException { 1432 return _layoutLocalService.updatePriority(groupId, privateLayout, 1433 layoutId, priority); 1434 } 1435 1436 /** 1437 * Updates the priority of the layout matching the primary key. 1438 * 1439 * @param plid the primary key of the layout 1440 * @param priority the layout's new priority 1441 * @return the updated layout 1442 * @throws PortalException if a layout with the primary key could not be 1443 found 1444 * @throws SystemException if a system exception occurred 1445 */ 1446 public com.liferay.portal.model.Layout updatePriority(long plid, 1447 int priority) 1448 throws com.liferay.portal.kernel.exception.PortalException, 1449 com.liferay.portal.kernel.exception.SystemException { 1450 return _layoutLocalService.updatePriority(plid, priority); 1451 } 1452 1453 /** 1454 * @deprecated As of 6.2.0, with no direct replacement 1455 */ 1456 public void updateScopedPortletNames(long groupId, boolean privateLayout, 1457 long layoutId, 1458 java.util.Map<java.util.Locale, java.lang.String> nameMap, 1459 java.util.List<java.util.Locale> nameMapModifiedLocales) 1460 throws com.liferay.portal.kernel.exception.PortalException, 1461 com.liferay.portal.kernel.exception.SystemException { 1462 _layoutLocalService.updateScopedPortletNames(groupId, privateLayout, 1463 layoutId, nameMap, nameMapModifiedLocales); 1464 } 1465 1466 /** 1467 * Updates the names of the portlets within scope of the group, the scope of 1468 * the layout's universally unique identifier, and the privacy. 1469 * 1470 * @param groupId the primary key of the group 1471 * @param privateLayout whether the layout is private to the group 1472 * @param layoutId the primary key of the layout whose universally 1473 unique identifier to match 1474 * @param name the new name for the portlets 1475 * @param languageId the primary key of the language 1476 * @throws PortalException if a matching layout could not be found 1477 * @throws SystemException if a system exception occurred 1478 * @see com.liferay.portlet.portletconfiguration.action.EditScopeAction 1479 * @deprecated As of 6.2.0, with no direct replacement 1480 */ 1481 public void updateScopedPortletNames(long groupId, boolean privateLayout, 1482 long layoutId, java.lang.String name, java.lang.String languageId) 1483 throws com.liferay.portal.kernel.exception.PortalException, 1484 com.liferay.portal.kernel.exception.SystemException { 1485 _layoutLocalService.updateScopedPortletNames(groupId, privateLayout, 1486 layoutId, name, languageId); 1487 } 1488 1489 /** 1490 * @deprecated Renamed to {@link #getWrappedService} 1491 */ 1492 public LayoutLocalService getWrappedLayoutLocalService() { 1493 return _layoutLocalService; 1494 } 1495 1496 /** 1497 * @deprecated Renamed to {@link #setWrappedService} 1498 */ 1499 public void setWrappedLayoutLocalService( 1500 LayoutLocalService layoutLocalService) { 1501 _layoutLocalService = layoutLocalService; 1502 } 1503 1504 public LayoutLocalService getWrappedService() { 1505 return _layoutLocalService; 1506 } 1507 1508 public void setWrappedService(LayoutLocalService layoutLocalService) { 1509 _layoutLocalService = layoutLocalService; 1510 } 1511 1512 private LayoutLocalService _layoutLocalService; 1513 }