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