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