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