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