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