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