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