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