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