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