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