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