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