001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.jsonwebservice.JSONWebService; 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.security.ac.AccessControlled; 026 027 /** 028 * Provides the remote service interface for Layout. Methods of this 029 * service are expected to have security checks based on the propagated JAAS 030 * credentials because this service can be accessed remotely. 031 * 032 * @author Brian Wing Shun Chan 033 * @see LayoutServiceUtil 034 * @see com.liferay.portal.service.base.LayoutServiceBaseImpl 035 * @see com.liferay.portal.service.impl.LayoutServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @AccessControlled 040 @JSONWebService 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface LayoutService extends BaseService { 044 /* 045 * NOTE FOR DEVELOPERS: 046 * 047 * Never modify or reference this interface directly. Always use {@link LayoutServiceUtil} to access the layout remote service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 048 */ 049 050 /** 051 * Returns the Spring bean ID for this bean. 052 * 053 * @return the Spring bean ID for this bean 054 */ 055 public java.lang.String getBeanIdentifier(); 056 057 /** 058 * Sets the Spring bean ID for this bean. 059 * 060 * @param beanIdentifier the Spring bean ID for this bean 061 */ 062 public void setBeanIdentifier(java.lang.String beanIdentifier); 063 064 /** 065 * Adds a layout with additional parameters. 066 * 067 * <p> 068 * This method handles the creation of the layout including its resources, 069 * metadata, and internal data structures. It is not necessary to make 070 * subsequent calls to any methods to setup default groups, resources, ... 071 * etc. 072 * </p> 073 * 074 * @param groupId the primary key of the group 075 * @param privateLayout whether the layout is private to the group 076 * @param parentLayoutId the primary key of the parent layout 077 (optionally {@link 078 com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 079 * @param localeNamesMap the layout's locales and localized names 080 * @param localeTitlesMap the layout's locales and localized titles 081 * @param descriptionMap the layout's locales and localized 082 descriptions 083 * @param keywordsMap the layout's locales and localized keywords 084 * @param robotsMap the layout's locales and localized robots 085 * @param type the layout's type (optionally {@link 086 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The 087 possible types can be found in {@link 088 com.liferay.portal.model.LayoutConstants}. 089 * @param hidden whether the layout is hidden 090 * @param friendlyURL the layout's locales and localized friendly URLs. 091 To see how the URL is normalized when accessed, see {@link 092 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 093 String)}. 094 * @param serviceContext the service context to be applied. Must set 095 the UUID for the layout. Can set the creation date, 096 modification date, and expando bridge attributes for the 097 layout. For layouts that belong to a layout set prototype, an 098 attribute named <code>layoutUpdateable</code> can be used to 099 specify whether site administrators can modify this page 100 within their site. 101 * @return the layout 102 * @throws PortalException if a group with the primary key could not be 103 found, if the group did not have permission to manage the 104 layouts involved, if layout values were invalid, or if a 105 portal exception occurred 106 * @throws SystemException if a system exception occurred 107 * @deprecated As of 6.2.0, replaced by {@link #addLayout(long, boolean, 108 long, Map, Map, Map, Map, Map, String, String, boolean, Map, 109 ServiceContext)} 110 */ 111 public com.liferay.portal.model.Layout addLayout(long groupId, 112 boolean privateLayout, long parentLayoutId, 113 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 114 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 115 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 116 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 117 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 118 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 119 com.liferay.portal.service.ServiceContext serviceContext) 120 throws com.liferay.portal.kernel.exception.PortalException, 121 com.liferay.portal.kernel.exception.SystemException; 122 123 /** 124 * Adds a layout with additional parameters. 125 * 126 * <p> 127 * This method handles the creation of the layout including its resources, 128 * metadata, and internal data structures. It is not necessary to make 129 * subsequent calls to any methods to setup default groups, resources, ... 130 * etc. 131 * </p> 132 * 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 (optionally 136 {@link 137 com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 138 * @param localeNamesMap the layout's locales and localized names 139 * @param localeTitlesMap the layout's locales and localized titles 140 * @param descriptionMap the layout's locales and localized descriptions 141 * @param keywordsMap the layout's locales and localized keywords 142 * @param robotsMap the layout's locales and localized robots 143 * @param type the layout's type (optionally {@link 144 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The 145 possible types can be found in {@link 146 com.liferay.portal.model.LayoutConstants}. 147 * @param typeSettings the settings to load the unicode properties object. 148 See {@link com.liferay.portal.kernel.util.UnicodeProperties 149 #fastLoad(String)}. 150 * @param hidden whether the layout is hidden 151 * @param friendlyURLMap the layout's locales and localized friendly URLs. 152 To see how the URL is normalized when accessed, see {@link 153 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 154 String)}. 155 * @param serviceContext the service context to be applied. Must set the 156 UUID for the layout. Can set the creation date, modification 157 date, and expando bridge attributes for the layout. For layouts 158 that belong to a layout set prototype, an attribute named 159 <code>layoutUpdateable</code> can be used to specify whether site 160 administrators can modify this page within their site. 161 * @return the layout 162 * @throws PortalException if a group with the primary key could not be 163 found, if the group did not have permission to manage the layouts 164 involved, if layout values were invalid, or if a portal exception 165 occurred 166 * @throws SystemException if a system exception occurred 167 */ 168 public com.liferay.portal.model.Layout addLayout(long groupId, 169 boolean privateLayout, long parentLayoutId, 170 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 171 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 172 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 173 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 174 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 175 java.lang.String type, java.lang.String typeSettings, boolean hidden, 176 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 177 com.liferay.portal.service.ServiceContext serviceContext) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Adds a layout with single entry maps for name, title, and description to 183 * the default locale. 184 * 185 * <p> 186 * This method handles the creation of the layout including its resources, 187 * metadata, and internal data structures. It is not necessary to make 188 * subsequent calls to any methods to setup default groups, resources, ... 189 * etc. 190 * </p> 191 * 192 * @param groupId the primary key of the group 193 * @param privateLayout whether the layout is private to the group 194 * @param parentLayoutId the primary key of the parent layout (optionally 195 {@link 196 com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID}) 197 * @param name Map the layout's locales and localized names 198 * @param title Map the layout's locales and localized titles 199 * @param description Map the layout's locales and localized descriptions 200 * @param type the layout's type (optionally {@link 201 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}). The 202 possible types can be found in {@link 203 com.liferay.portal.model.LayoutConstants}. 204 * @param hidden whether the layout is hidden 205 * @param friendlyURL the layout's locales and localized friendly URLs. To 206 see how the URL is normalized when accessed, see {@link 207 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 208 String)}. 209 * @param serviceContext the service context to be applied. Must set the 210 UUID for the layout. Can specify the creation date, modification 211 date, and expando bridge attributes for the layout. For layouts 212 that belong to a layout set prototype, an attribute named 213 <code>layoutUpdateable</code> can be used to specify whether site 214 administrators can modify this page within their site. 215 * @return the layout 216 * @throws PortalException if a group with the primary key could not be 217 found, if the group did not have permission to manage the layouts 218 involved, if layout values were invalid, or if a portal exception 219 occurred 220 * @throws SystemException if a system exception occurred 221 */ 222 public com.liferay.portal.model.Layout addLayout(long groupId, 223 boolean privateLayout, long parentLayoutId, java.lang.String name, 224 java.lang.String title, java.lang.String description, 225 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 226 com.liferay.portal.service.ServiceContext serviceContext) 227 throws com.liferay.portal.kernel.exception.PortalException, 228 com.liferay.portal.kernel.exception.SystemException; 229 230 public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry( 231 long groupId, java.lang.String fileName, 232 java.lang.String tempFolderName, java.io.InputStream inputStream, 233 java.lang.String mimeType) 234 throws com.liferay.portal.kernel.exception.PortalException, 235 com.liferay.portal.kernel.exception.SystemException; 236 237 /** 238 * Deletes the layout with the primary key, also deleting the layout's child 239 * 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 layoutId the primary key of the layout 244 * @param serviceContext the service context to be applied 245 * @throws PortalException if the user did not have permission to delete the 246 layout, if a matching layout could not be found , or if some 247 other portal exception occurred 248 * @throws SystemException if a system exception occurred 249 */ 250 public void deleteLayout(long groupId, boolean privateLayout, 251 long layoutId, com.liferay.portal.service.ServiceContext serviceContext) 252 throws com.liferay.portal.kernel.exception.PortalException, 253 com.liferay.portal.kernel.exception.SystemException; 254 255 /** 256 * Deletes the layout with the plid, also deleting the layout's child 257 * layouts, and associated resources. 258 * 259 * @param plid the primary key of the layout 260 * @param serviceContext the service context to be applied 261 * @throws PortalException if the user did not have permission to delete the 262 layout, if a layout with the primary key could not be found , or 263 if some other portal exception occurred 264 * @throws SystemException if a system exception occurred 265 */ 266 public void deleteLayout(long plid, 267 com.liferay.portal.service.ServiceContext serviceContext) 268 throws com.liferay.portal.kernel.exception.PortalException, 269 com.liferay.portal.kernel.exception.SystemException; 270 271 public void deleteTempFileEntry(long groupId, java.lang.String fileName, 272 java.lang.String tempFolderName) 273 throws com.liferay.portal.kernel.exception.PortalException, 274 com.liferay.portal.kernel.exception.SystemException; 275 276 /** 277 * Exports the layouts that match the primary keys and the criteria as a 278 * byte array. 279 * 280 * @param groupId the primary key of the group 281 * @param privateLayout whether the layout is private to the group 282 * @param layoutIds the primary keys of the layouts to be exported 283 * @param parameterMap the mapping of parameters indicating which 284 information to export. For information on the keys used in the 285 map see {@link 286 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 287 * @param startDate the export's start date 288 * @param endDate the export's end date 289 * @return the layouts as a byte array 290 * @throws PortalException if a group or any layout with the primary key 291 could not be found, if the group did not have permission to 292 manage the layouts, or if some other portal exception occurred 293 * @throws SystemException if a system exception occurred 294 */ 295 public byte[] exportLayouts(long groupId, boolean privateLayout, 296 long[] layoutIds, 297 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 298 java.util.Date startDate, java.util.Date endDate) 299 throws com.liferay.portal.kernel.exception.PortalException, 300 com.liferay.portal.kernel.exception.SystemException; 301 302 /** 303 * Exports all layouts that match the criteria as a byte array. 304 * 305 * @param groupId the primary key of the group 306 * @param privateLayout whether the layout is private to the group 307 * @param parameterMap the mapping of parameters indicating which 308 information to export. For information on the keys used in the 309 map see {@link 310 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 311 * @param startDate the export's start date 312 * @param endDate the export's end date 313 * @return the layout as a byte array 314 * @throws PortalException if a group with the primary key could not be 315 found, if the group did not have permission to manage the 316 layouts, or if some other portal exception occurred 317 * @throws SystemException if a system exception occurred 318 */ 319 public byte[] exportLayouts(long groupId, boolean privateLayout, 320 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 321 java.util.Date startDate, java.util.Date endDate) 322 throws com.liferay.portal.kernel.exception.PortalException, 323 com.liferay.portal.kernel.exception.SystemException; 324 325 /** 326 * Exports all layouts that match the primary keys and criteria as a file. 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 (optionally <code>null</code>) 332 * @param parameterMap the mapping of parameters indicating which 333 information to export. For information on the keys used in the 334 map see {@link 335 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 336 * @param startDate the export's start date 337 * @param endDate the export's end date 338 * @return the layouts as a File 339 * @throws PortalException if a group or any layout with the primary key 340 could not be found, it the group did not have permission to 341 manage the layouts, or if some other portal exception occurred 342 * @throws SystemException if a system exception occurred 343 */ 344 public java.io.File exportLayoutsAsFile(long groupId, 345 boolean privateLayout, long[] layoutIds, 346 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 347 java.util.Date startDate, java.util.Date endDate) 348 throws com.liferay.portal.kernel.exception.PortalException, 349 com.liferay.portal.kernel.exception.SystemException; 350 351 public long exportLayoutsAsFileInBackground(java.lang.String taskName, 352 long groupId, boolean privateLayout, long[] layoutIds, 353 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 354 java.util.Date startDate, java.util.Date endDate, 355 java.lang.String fileName) 356 throws com.liferay.portal.kernel.exception.PortalException, 357 com.liferay.portal.kernel.exception.SystemException; 358 359 /** 360 * Exports the portlet information (categories, permissions, ... etc.) as a 361 * byte array. 362 * 363 * @param plid the primary key of the layout 364 * @param groupId the primary key of the group 365 * @param portletId the primary key of the portlet 366 * @param parameterMap the mapping of parameters indicating which 367 information to export. For information on the keys used in the 368 map see {@link 369 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 370 * @param startDate the export's start date 371 * @param endDate the export's end date 372 * @return the portlet information as a byte array 373 * @throws PortalException if a layout, group, or portlet with the primary 374 key could not be found, if the group did not have permission to 375 manage the layouts involved, or if some other portal exception 376 occurred 377 * @throws SystemException if a system exception occurred 378 */ 379 public byte[] exportPortletInfo(long plid, long groupId, 380 java.lang.String portletId, 381 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 382 java.util.Date startDate, java.util.Date endDate) 383 throws com.liferay.portal.kernel.exception.PortalException, 384 com.liferay.portal.kernel.exception.SystemException; 385 386 public byte[] exportPortletInfo(long companyId, java.lang.String portletId, 387 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 388 java.util.Date startDate, java.util.Date endDate) 389 throws com.liferay.portal.kernel.exception.PortalException, 390 com.liferay.portal.kernel.exception.SystemException; 391 392 /** 393 * Exports the portlet information (categories, permissions, ... etc.) as a 394 * file. 395 * 396 * @param plid the primary key of the layout 397 * @param groupId the primary key of the group 398 * @param portletId the primary key of the portlet 399 * @param parameterMap the mapping of parameters indicating which 400 information to export. For information on the keys used in the 401 map see {@link 402 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 403 * @param startDate the export's start date 404 * @param endDate the export's end date 405 * @return the portlet information as a file 406 * @throws PortalException if a layout, group, or portlet with the primary 407 key could not be found, it the group did not have permission to 408 manage the layouts involved, or if some other portal exception 409 occurred 410 * @throws SystemException if a system exception occurred 411 */ 412 public java.io.File exportPortletInfoAsFile(long plid, long groupId, 413 java.lang.String portletId, 414 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 415 java.util.Date startDate, java.util.Date endDate) 416 throws com.liferay.portal.kernel.exception.PortalException, 417 com.liferay.portal.kernel.exception.SystemException; 418 419 public java.io.File exportPortletInfoAsFile(java.lang.String portletId, 420 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 421 java.util.Date startDate, java.util.Date endDate) 422 throws com.liferay.portal.kernel.exception.PortalException, 423 com.liferay.portal.kernel.exception.SystemException; 424 425 public long exportPortletInfoAsFileInBackground(java.lang.String taskName, 426 long plid, long groupId, java.lang.String portletId, 427 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 428 java.util.Date startDate, java.util.Date endDate, 429 java.lang.String fileName) 430 throws com.liferay.portal.kernel.exception.PortalException, 431 com.liferay.portal.kernel.exception.SystemException; 432 433 public long exportPortletInfoAsFileInBackground(java.lang.String taskName, 434 java.lang.String portletId, 435 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 436 java.util.Date startDate, java.util.Date endDate, 437 java.lang.String fileName) 438 throws com.liferay.portal.kernel.exception.PortalException, 439 com.liferay.portal.kernel.exception.SystemException; 440 441 /** 442 * Returns all the ancestor layouts of the layout. 443 * 444 * @param plid the primary key of the layout 445 * @return the ancestor layouts of the layout 446 * @throws PortalException if a matching layout could not be found or if a 447 portal exception occurred 448 * @throws SystemException if a system exception occurred 449 */ 450 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 451 public java.util.List<com.liferay.portal.model.Layout> getAncestorLayouts( 452 long plid) 453 throws com.liferay.portal.kernel.exception.PortalException, 454 com.liferay.portal.kernel.exception.SystemException; 455 456 /** 457 * Returns the primary key of the default layout for the group. 458 * 459 * @param groupId the primary key of the group 460 * @param scopeGroupId the primary key of the scope group. See {@link 461 com.liferay.portal.service.ServiceContext#getScopeGroupId()}. 462 * @param privateLayout whether the layout is private to the group 463 * @param portletId the primary key of the portlet 464 * @return Returns the primary key of the default layout group; {@link 465 com.liferay.portal.model.LayoutConstants#DEFAULT_PLID} otherwise 466 * @throws PortalException if a group, layout, or portlet with the primary 467 key could not be found 468 * @throws SystemException if a system exception occurred 469 */ 470 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 471 public long getDefaultPlid(long groupId, long scopeGroupId, 472 boolean privateLayout, java.lang.String portletId) 473 throws com.liferay.portal.kernel.exception.PortalException, 474 com.liferay.portal.kernel.exception.SystemException; 475 476 @com.liferay.portal.kernel.cache.ThreadLocalCachable 477 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 478 public long getDefaultPlid(long groupId, long scopeGroupId, 479 java.lang.String portletId) 480 throws com.liferay.portal.kernel.exception.PortalException, 481 com.liferay.portal.kernel.exception.SystemException; 482 483 /** 484 * Returns the layout matching the UUID, group, and privacy. 485 * 486 * @param uuid the layout's UUID 487 * @param groupId the primary key of the group 488 * @param privateLayout whether the layout is private to the group 489 * @return the matching layout 490 * @throws PortalException if a matching layout could not be found, if the 491 user did not have permission to view the layout, or if some other 492 portal exception occurred 493 * @throws SystemException if a system exception occurred 494 */ 495 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 496 public com.liferay.portal.model.Layout getLayoutByUuidAndGroupId( 497 java.lang.String uuid, long groupId, boolean privateLayout) 498 throws com.liferay.portal.kernel.exception.PortalException, 499 com.liferay.portal.kernel.exception.SystemException; 500 501 /** 502 * Returns the name of the layout. 503 * 504 * @param groupId the primary key of the group 505 * @param privateLayout whether the layout is private to the group 506 * @param layoutId the primary key of the layout 507 * @param languageId the primary key of the language. For more information 508 See {@link java.util.Locale}. 509 * @return the layout's name 510 * @throws PortalException if a matching layout could not be found 511 * @throws SystemException if a system exception occurred 512 */ 513 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 514 public java.lang.String getLayoutName(long groupId, boolean privateLayout, 515 long layoutId, java.lang.String languageId) 516 throws com.liferay.portal.kernel.exception.PortalException, 517 com.liferay.portal.kernel.exception.SystemException; 518 519 /** 520 * Returns the layout references for all the layouts that belong to the 521 * company and belong to the portlet that matches the preferences. 522 * 523 * @param companyId the primary key of the company 524 * @param portletId the primary key of the portlet 525 * @param preferencesKey the portlet's preference key 526 * @param preferencesValue the portlet's preference value 527 * @return the layout references of the matching layouts 528 * @throws SystemException if a system exception occurred 529 */ 530 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 531 public com.liferay.portal.model.LayoutReference[] getLayoutReferences( 532 long companyId, java.lang.String portletId, 533 java.lang.String preferencesKey, java.lang.String preferencesValue) 534 throws com.liferay.portal.kernel.exception.SystemException; 535 536 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 537 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 538 long groupId, boolean privateLayout) 539 throws com.liferay.portal.kernel.exception.SystemException; 540 541 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 542 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 543 long groupId, boolean privateLayout, long parentLayoutId) 544 throws com.liferay.portal.kernel.exception.SystemException; 545 546 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 547 public java.util.List<com.liferay.portal.model.Layout> getLayouts( 548 long groupId, boolean privateLayout, long parentLayoutId, 549 boolean incomplete, int start, int end) 550 throws com.liferay.portal.kernel.exception.PortalException, 551 com.liferay.portal.kernel.exception.SystemException; 552 553 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 554 public int getLayoutsCount(long groupId, boolean privateLayout, 555 long parentLayoutId) 556 throws com.liferay.portal.kernel.exception.SystemException; 557 558 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 559 public int getLayoutsCount(long groupId, boolean privateLayout, 560 long parentLayoutId, int priority) 561 throws com.liferay.portal.kernel.exception.SystemException; 562 563 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 564 public java.lang.String[] getTempFileEntryNames(long groupId, 565 java.lang.String tempFolderName) 566 throws com.liferay.portal.kernel.exception.PortalException, 567 com.liferay.portal.kernel.exception.SystemException; 568 569 /** 570 * Imports the layouts from the byte array. 571 * 572 * @param groupId the primary key of the group 573 * @param privateLayout whether the layout is private to the group 574 * @param parameterMap the mapping of parameters indicating which 575 information will be imported. For information on the keys used in 576 the map see {@link 577 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 578 * @param bytes the byte array with the data 579 * @throws PortalException if a group with the primary key could not be 580 found, if the group did not have permission to manage the 581 layouts, or if some other portal exception occurred 582 * @throws SystemException if a system exception occurred 583 * @see com.liferay.portal.lar.LayoutImporter 584 */ 585 public void importLayouts(long groupId, boolean privateLayout, 586 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 587 byte[] bytes) 588 throws com.liferay.portal.kernel.exception.PortalException, 589 com.liferay.portal.kernel.exception.SystemException; 590 591 /** 592 * Imports the layouts from the file. 593 * 594 * @param groupId the primary key of the group 595 * @param privateLayout whether the layout is private to the group 596 * @param parameterMap the mapping of parameters indicating which 597 information will be imported. For information on the keys used in 598 the map see {@link 599 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 600 * @param file the LAR file with the data 601 * @throws PortalException if a group with the primary key could not be 602 found, if the group did not have permission to manage the layouts 603 and publish, or if some other portal exception occurred 604 * @throws SystemException if a system exception occurred 605 * @see com.liferay.portal.lar.LayoutImporter 606 */ 607 public void importLayouts(long groupId, boolean privateLayout, 608 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 609 java.io.File file) 610 throws com.liferay.portal.kernel.exception.PortalException, 611 com.liferay.portal.kernel.exception.SystemException; 612 613 /** 614 * Imports the layouts from the input stream. 615 * 616 * @param groupId the primary key of the group 617 * @param privateLayout whether the layout is private to the group 618 * @param parameterMap the mapping of parameters indicating which 619 information will be imported. For information on the keys used in 620 the map see {@link 621 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 622 * @param is the input stream 623 * @throws PortalException if a group with the primary key could not be 624 found, if the group did not have permission to manage the 625 layouts, or if some other portal exception occurred 626 * @throws SystemException if a system exception occurred 627 * @see com.liferay.portal.lar.LayoutImporter 628 */ 629 public void importLayouts(long groupId, boolean privateLayout, 630 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 631 java.io.InputStream is) 632 throws com.liferay.portal.kernel.exception.PortalException, 633 com.liferay.portal.kernel.exception.SystemException; 634 635 public long importLayoutsInBackground(java.lang.String taskName, 636 long groupId, boolean privateLayout, 637 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 638 java.io.File file) 639 throws com.liferay.portal.kernel.exception.PortalException, 640 com.liferay.portal.kernel.exception.SystemException; 641 642 public long importLayoutsInBackground(java.lang.String taskName, 643 long groupId, boolean privateLayout, 644 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 645 java.io.InputStream inputStream) 646 throws com.liferay.portal.kernel.exception.PortalException, 647 com.liferay.portal.kernel.exception.SystemException; 648 649 /** 650 * Imports the portlet information (categories, permissions, ... etc.) from 651 * the file. 652 * 653 * @param plid the primary key of the layout 654 * @param groupId the primary key of the group 655 * @param portletId the primary key of the portlet 656 * @param parameterMap the mapping of parameters indicating which 657 information will be imported. For information on the keys used in 658 the map see {@link 659 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 660 * @param file the LAR file with the data 661 * @throws PortalException if a group, layout, or portlet with the primary 662 key could not be found, or if the group did not have permission 663 to manage the layouts 664 * @throws SystemException if a system exception occurred 665 */ 666 public void importPortletInfo(long plid, long groupId, 667 java.lang.String portletId, 668 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 669 java.io.File file) 670 throws com.liferay.portal.kernel.exception.PortalException, 671 com.liferay.portal.kernel.exception.SystemException; 672 673 /** 674 * Imports the portlet information (categories, permissions, ... etc.) from 675 * the input stream. 676 * 677 * @param plid the primary key of the layout 678 * @param groupId the primary key of the group 679 * @param portletId the primary key of the portlet 680 * @param parameterMap the mapping of parameters indicating which 681 information will be imported. For information on the keys used in 682 the map see {@link 683 com.liferay.portal.kernel.lar.PortletDataHandlerKeys}. 684 * @param is the input stream 685 * @throws PortalException if a group, portlet, or layout with the primary 686 key could not be found or if the group did not have permission to 687 manage the layouts 688 * @throws SystemException if a system exception occurred 689 */ 690 public void importPortletInfo(long plid, long groupId, 691 java.lang.String portletId, 692 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 693 java.io.InputStream is) 694 throws com.liferay.portal.kernel.exception.PortalException, 695 com.liferay.portal.kernel.exception.SystemException; 696 697 public void importPortletInfo(java.lang.String portletId, 698 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 699 java.io.File file) 700 throws com.liferay.portal.kernel.exception.PortalException, 701 com.liferay.portal.kernel.exception.SystemException; 702 703 public void importPortletInfo(java.lang.String portletId, 704 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 705 java.io.InputStream is) 706 throws com.liferay.portal.kernel.exception.PortalException, 707 com.liferay.portal.kernel.exception.SystemException; 708 709 public long importPortletInfoInBackground(java.lang.String taskName, 710 long plid, long groupId, java.lang.String portletId, 711 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 712 java.io.File file) 713 throws com.liferay.portal.kernel.exception.PortalException, 714 com.liferay.portal.kernel.exception.SystemException; 715 716 public long importPortletInfoInBackground(java.lang.String taskName, 717 long plid, long groupId, java.lang.String portletId, 718 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 719 java.io.InputStream is) 720 throws com.liferay.portal.kernel.exception.PortalException, 721 com.liferay.portal.kernel.exception.SystemException; 722 723 public void importPortletInfoInBackground(java.lang.String taskName, 724 java.lang.String portletId, 725 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 726 java.io.File file) 727 throws com.liferay.portal.kernel.exception.PortalException, 728 com.liferay.portal.kernel.exception.SystemException; 729 730 public void importPortletInfoInBackground(java.lang.String taskName, 731 java.lang.String portletId, 732 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 733 java.io.InputStream is) 734 throws com.liferay.portal.kernel.exception.PortalException, 735 com.liferay.portal.kernel.exception.SystemException; 736 737 /** 738 * Schedules a range of layouts to be published. 739 * 740 * @param sourceGroupId the primary key of the source group 741 * @param targetGroupId the primary key of the target group 742 * @param privateLayout whether the layout is private to the group 743 * @param layoutIdMap the layouts considered for publishing, specified by 744 the layout IDs and booleans indicating whether they have children 745 * @param parameterMap the mapping of parameters indicating which 746 information will be used. See {@link 747 com.liferay.portal.kernel.lar.PortletDataHandlerKeys} 748 * @param scope the scope of the pages. It can be <code>all-pages</code> or 749 <code>selected-pages</code>. 750 * @param startDate the start date 751 * @param endDate the end date 752 * @param groupName the group name (optionally {@link 753 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 754 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 755 * @param cronText the cron text. See {@link 756 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 757 * @param schedulerStartDate the scheduler start date 758 * @param schedulerEndDate the scheduler end date 759 * @param description the scheduler description 760 * @throws PortalException if the group did not have permission to manage 761 and publish 762 * @throws SystemException if a system exception occurred 763 */ 764 public void schedulePublishToLive(long sourceGroupId, long targetGroupId, 765 boolean privateLayout, 766 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 767 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 768 java.lang.String scope, java.util.Date startDate, 769 java.util.Date endDate, java.lang.String groupName, 770 java.lang.String cronText, java.util.Date schedulerStartDate, 771 java.util.Date schedulerEndDate, java.lang.String description) 772 throws com.liferay.portal.kernel.exception.PortalException, 773 com.liferay.portal.kernel.exception.SystemException; 774 775 /** 776 * Schedules a range of layouts to be stored. 777 * 778 * @param sourceGroupId the primary key of the source group 779 * @param privateLayout whether the layout is private to the group 780 * @param layoutIdMap the layouts considered for publishing, specified by 781 the layout IDs and booleans indicating whether they have children 782 * @param parameterMap the mapping of parameters indicating which 783 information will be used. See {@link 784 com.liferay.portal.kernel.lar.PortletDataHandlerKeys} 785 * @param remoteAddress the remote address 786 * @param remotePort the remote port 787 * @param remotePathContext the remote path context 788 * @param secureConnection whether the connection is secure 789 * @param remoteGroupId the primary key of the remote group 790 * @param remotePrivateLayout whether remote group's layout is private 791 * @param startDate the start date 792 * @param endDate the end date 793 * @param groupName the group name. Optionally {@link 794 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 795 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 796 * @param cronText the cron text. See {@link 797 com.liferay.portal.kernel.cal.RecurrenceSerializer #toCronText} 798 * @param schedulerStartDate the scheduler start date 799 * @param schedulerEndDate the scheduler end date 800 * @param description the scheduler description 801 * @throws PortalException if a group with the source group primary key was 802 not found or if the group did not have permission to publish 803 * @throws SystemException if a system exception occurred 804 */ 805 public void schedulePublishToRemote(long sourceGroupId, 806 boolean privateLayout, 807 java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap, 808 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 809 java.lang.String remoteAddress, int remotePort, 810 java.lang.String remotePathContext, boolean secureConnection, 811 long remoteGroupId, boolean remotePrivateLayout, 812 java.util.Date startDate, java.util.Date endDate, 813 java.lang.String groupName, java.lang.String cronText, 814 java.util.Date schedulerStartDate, java.util.Date schedulerEndDate, 815 java.lang.String description) 816 throws com.liferay.portal.kernel.exception.PortalException, 817 com.liferay.portal.kernel.exception.SystemException; 818 819 /** 820 * Sets the layouts for the group, replacing and prioritizing all layouts of 821 * the parent layout. 822 * 823 * @param groupId the primary key of the group 824 * @param privateLayout whether the layout is private to the group 825 * @param parentLayoutId the primary key of the parent layout 826 * @param layoutIds the primary keys of the layouts 827 * @param serviceContext the service context to be applied 828 * @throws PortalException if a group or layout with the primary key could 829 not be found, if the group did not have permission to manage the 830 layouts, if no layouts were specified, if the first layout was 831 not page-able, if the first layout was hidden, or if some other 832 portal exception occurred 833 * @throws SystemException if a system exception occurred 834 */ 835 public void setLayouts(long groupId, boolean privateLayout, 836 long parentLayoutId, long[] layoutIds, 837 com.liferay.portal.service.ServiceContext serviceContext) 838 throws com.liferay.portal.kernel.exception.PortalException, 839 com.liferay.portal.kernel.exception.SystemException; 840 841 /** 842 * Deletes the job from the scheduler's queue. 843 * 844 * @param groupId the primary key of the group 845 * @param jobName the job name 846 * @param groupName the group name (optionally {@link 847 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 848 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 849 * @throws PortalException if the group did not permission to manage staging 850 and publish 851 * @throws SystemException if a system exception occurred 852 */ 853 public void unschedulePublishToLive(long groupId, java.lang.String jobName, 854 java.lang.String groupName) 855 throws com.liferay.portal.kernel.exception.PortalException, 856 com.liferay.portal.kernel.exception.SystemException; 857 858 /** 859 * Deletes the job from the scheduler's persistent queue. 860 * 861 * @param groupId the primary key of the group 862 * @param jobName the job name 863 * @param groupName the group name (optionally {@link 864 com.liferay.portal.kernel.messaging.DestinationNames#LAYOUTS_LOCAL_PUBLISHER}). 865 See {@link com.liferay.portal.kernel.messaging.DestinationNames}. 866 * @throws PortalException if a group with the primary key could not be 867 found or if the group did not have permission to publish 868 * @throws SystemException if a system exception occurred 869 */ 870 public void unschedulePublishToRemote(long groupId, 871 java.lang.String jobName, java.lang.String groupName) 872 throws com.liferay.portal.kernel.exception.PortalException, 873 com.liferay.portal.kernel.exception.SystemException; 874 875 /** 876 * Updates the layout with additional parameters. 877 * 878 * @param groupId the primary key of the group 879 * @param privateLayout whether the layout is private to the group 880 * @param layoutId the primary key of the layout 881 * @param parentLayoutId the primary key of the layout's new parent layout 882 * @param localeNamesMap the layout's locales and localized names 883 * @param localeTitlesMap the layout's locales and localized titles 884 * @param descriptionMap the locales and localized descriptions to merge 885 (optionally <code>null</code>) 886 * @param keywordsMap the locales and localized keywords to merge 887 (optionally <code>null</code>) 888 * @param robotsMap the locales and localized robots to merge (optionally 889 <code>null</code>) 890 * @param type the layout's new type (optionally {@link 891 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 892 * @param hidden whether the layout is hidden 893 * @param friendlyURLMap the layout's locales and localized friendly URLs. 894 To see how the URL is normalized when accessed see {@link 895 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 896 String)}. 897 * @param iconImage whether the icon image will be updated 898 * @param iconBytes the byte array of the layout's new icon image 899 * @param serviceContext the service context to be applied. Can set the 900 modification date and expando bridge attributes for the layout. 901 * @return the updated layout 902 * @throws PortalException if a group or layout with the primary key could 903 not be found, if the user did not have permission to update the 904 layout, if a unique friendly URL could not be generated, if a 905 valid parent layout ID to use could not be found, or if the 906 layout parameters were invalid 907 * @throws SystemException if a system exception occurred 908 */ 909 public com.liferay.portal.model.Layout updateLayout(long groupId, 910 boolean privateLayout, long layoutId, long parentLayoutId, 911 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 912 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 913 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 914 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 915 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 916 java.lang.String type, boolean hidden, 917 java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap, 918 java.lang.Boolean iconImage, byte[] iconBytes, 919 com.liferay.portal.service.ServiceContext serviceContext) 920 throws com.liferay.portal.kernel.exception.PortalException, 921 com.liferay.portal.kernel.exception.SystemException; 922 923 /** 924 * Updates the layout with additional parameters. 925 * 926 * @param groupId the primary key of the group 927 * @param privateLayout whether the layout is private to the group 928 * @param layoutId the primary key of the layout 929 * @param parentLayoutId the primary key of the layout's new parent 930 layout 931 * @param localeNamesMap the layout's locales and localized names 932 * @param localeTitlesMap the layout's locales and localized titles 933 * @param descriptionMap the locales and localized descriptions to 934 merge (optionally <code>null</code>) 935 * @param keywordsMap the locales and localized keywords to merge 936 (optionally <code>null</code>) 937 * @param robotsMap the locales and localized robots to merge 938 (optionally <code>null</code>) 939 * @param type the layout's new type (optionally {@link 940 com.liferay.portal.model.LayoutConstants#TYPE_PORTLET}) 941 * @param hidden whether the layout is hidden 942 * @param friendlyURL the layout's locales and new friendly URLs. To 943 see how the URL is normalized when accessed, see {@link 944 com.liferay.portal.kernel.util.FriendlyURLNormalizerUtil#normalize( 945 String)}. 946 * @param iconImage whether the icon image will be updated 947 * @param iconBytes the byte array of the layout's new icon image 948 * @param serviceContext the service context to be applied. Can set the 949 modification date and expando bridge attributes for the 950 layout. 951 * @return the updated layout 952 * @throws PortalException if a group or layout with the primary key 953 could not be found, if the user did not have permission to 954 update the layout, if a unique friendly URL could not be 955 generated, if a valid parent layout ID to use could not be 956 found, or if the layout parameters were invalid 957 * @throws SystemException if a system exception occurred 958 * @deprecated As of 6.2.0, replaced by {@link #updateLayout(long, boolean, 959 long, long, Map, Map, Map, Map, Map, String, boolean, Map, 960 Boolean, byte[], ServiceContext)} 961 */ 962 public com.liferay.portal.model.Layout updateLayout(long groupId, 963 boolean privateLayout, long layoutId, long parentLayoutId, 964 java.util.Map<java.util.Locale, java.lang.String> localeNamesMap, 965 java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap, 966 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 967 java.util.Map<java.util.Locale, java.lang.String> keywordsMap, 968 java.util.Map<java.util.Locale, java.lang.String> robotsMap, 969 java.lang.String type, boolean hidden, java.lang.String friendlyURL, 970 java.lang.Boolean iconImage, byte[] iconBytes, 971 com.liferay.portal.service.ServiceContext serviceContext) 972 throws com.liferay.portal.kernel.exception.PortalException, 973 com.liferay.portal.kernel.exception.SystemException; 974 975 /** 976 * Updates the layout replacing its type settings. 977 * 978 * @param groupId the primary key of the group 979 * @param privateLayout whether the layout is private to the group 980 * @param layoutId the primary key of the layout 981 * @param typeSettings the settings to load the unicode properties object. 982 See {@link com.liferay.portal.kernel.util.UnicodeProperties 983 #fastLoad(String)}. 984 * @return the updated layout 985 * @throws PortalException if a matching layout could not be found or if the 986 user did not have permission to update the layout 987 * @throws SystemException if a system exception occurred 988 */ 989 public com.liferay.portal.model.Layout updateLayout(long groupId, 990 boolean privateLayout, long layoutId, java.lang.String typeSettings) 991 throws com.liferay.portal.kernel.exception.PortalException, 992 com.liferay.portal.kernel.exception.SystemException; 993 994 /** 995 * Updates the look and feel of the layout. 996 * 997 * @param groupId the primary key of the group 998 * @param privateLayout whether the layout is private to the group 999 * @param layoutId the primary key of the layout 1000 * @param themeId the primary key of the layout's new theme 1001 * @param colorSchemeId the primary key of the layout's new color scheme 1002 * @param css the layout's new CSS 1003 * @param wapTheme whether the theme is for WAP browsers 1004 * @return the updated layout 1005 * @throws PortalException if a matching layout could not be found, or if 1006 the user did not have permission to update the layout and 1007 permission to apply the theme 1008 * @throws SystemException if a system exception occurred 1009 */ 1010 public com.liferay.portal.model.Layout updateLookAndFeel(long groupId, 1011 boolean privateLayout, long layoutId, java.lang.String themeId, 1012 java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme) 1013 throws com.liferay.portal.kernel.exception.PortalException, 1014 com.liferay.portal.kernel.exception.SystemException; 1015 1016 /** 1017 * Updates the name of the layout matching the group, layout ID, and 1018 * privacy. 1019 * 1020 * @param groupId the primary key of the group 1021 * @param privateLayout whether the layout is private to the group 1022 * @param layoutId the primary key of the layout 1023 * @param name the layout's new name 1024 * @param languageId the primary key of the language. For more information 1025 see {@link java.util.Locale}. 1026 * @return the updated layout 1027 * @throws PortalException if a matching layout could not be found, if the 1028 user did not have permission to update the layout, or if the new 1029 name was <code>null</code> 1030 * @throws SystemException if a system exception occurred 1031 */ 1032 public com.liferay.portal.model.Layout updateName(long groupId, 1033 boolean privateLayout, long layoutId, java.lang.String name, 1034 java.lang.String languageId) 1035 throws com.liferay.portal.kernel.exception.PortalException, 1036 com.liferay.portal.kernel.exception.SystemException; 1037 1038 /** 1039 * Updates the name of the layout matching the primary key. 1040 * 1041 * @param plid the primary key of the layout 1042 * @param name the name to be assigned 1043 * @param languageId the primary key of the language. For more information 1044 see {@link java.util.Locale}. 1045 * @return the updated layout 1046 * @throws PortalException if a layout with the primary key could not be 1047 found, or if the user did not have permission to update the 1048 layout, or if the name was <code>null</code> 1049 * @throws SystemException if a system exception occurred 1050 */ 1051 public com.liferay.portal.model.Layout updateName(long plid, 1052 java.lang.String name, java.lang.String languageId) 1053 throws com.liferay.portal.kernel.exception.PortalException, 1054 com.liferay.portal.kernel.exception.SystemException; 1055 1056 /** 1057 * Updates the parent layout ID of the layout matching the group, layout ID, 1058 * and privacy. 1059 * 1060 * @param groupId the primary key of the group 1061 * @param privateLayout whether the layout is private to the group 1062 * @param layoutId the primary key of the layout 1063 * @param parentLayoutId the primary key to be assigned to the parent 1064 layout 1065 * @return the matching layout 1066 * @throws PortalException if a valid parent layout ID to use could not be 1067 found, if a matching layout could not be found, or if the user 1068 did not have permission to update the layout 1069 * @throws SystemException if a system exception occurred 1070 */ 1071 public com.liferay.portal.model.Layout updateParentLayoutId(long groupId, 1072 boolean privateLayout, long layoutId, long parentLayoutId) 1073 throws com.liferay.portal.kernel.exception.PortalException, 1074 com.liferay.portal.kernel.exception.SystemException; 1075 1076 /** 1077 * Updates the parent layout ID of the layout matching the primary key. If a 1078 * layout matching the parent primary key is found, the layout ID of that 1079 * layout is assigned, otherwise {@link 1080 * com.liferay.portal.model.LayoutConstants#DEFAULT_PARENT_LAYOUT_ID} is 1081 * assigned. 1082 * 1083 * @param plid the primary key of the layout 1084 * @param parentPlid the primary key of the parent layout 1085 * @return the layout matching the primary key 1086 * @throws PortalException if a layout with the primary key could not be 1087 found, if the user did not have permission to update the layout, 1088 or if a valid parent layout ID to use could not be found 1089 * @throws SystemException if a system exception occurred 1090 */ 1091 public com.liferay.portal.model.Layout updateParentLayoutId(long plid, 1092 long parentPlid) 1093 throws com.liferay.portal.kernel.exception.PortalException, 1094 com.liferay.portal.kernel.exception.SystemException; 1095 1096 public com.liferay.portal.model.Layout updateParentLayoutIdAndPriority( 1097 long plid, long parentPlid, int priority) 1098 throws com.liferay.portal.kernel.exception.PortalException, 1099 com.liferay.portal.kernel.exception.SystemException; 1100 1101 /** 1102 * Updates the priority of the layout matching the group, layout ID, and 1103 * privacy. 1104 * 1105 * @param groupId the primary key of the group 1106 * @param privateLayout whether the layout is private to the group 1107 * @param layoutId the primary key of the layout 1108 * @param priority the layout's new priority 1109 * @return the updated layout 1110 * @throws PortalException if a matching layout could not be found or if the 1111 user did not have permission to update the layout 1112 * @throws SystemException if a system exception occurred 1113 */ 1114 public com.liferay.portal.model.Layout updatePriority(long groupId, 1115 boolean privateLayout, long layoutId, int priority) 1116 throws com.liferay.portal.kernel.exception.PortalException, 1117 com.liferay.portal.kernel.exception.SystemException; 1118 1119 /** 1120 * Updates the priority of the layout matching the group, layout ID, and 1121 * privacy, setting the layout's priority based on the priorities of the 1122 * next and previous layouts. 1123 * 1124 * @param groupId the primary key of the group 1125 * @param privateLayout whether the layout is private to the group 1126 * @param layoutId the primary key of the layout 1127 * @param nextLayoutId the primary key of the next layout 1128 * @param previousLayoutId the primary key of the previous layout 1129 * @return the updated layout 1130 * @throws PortalException if a matching layout could not be found or if the 1131 user did not have permission to update the layout 1132 * @throws SystemException if a system exception occurred 1133 */ 1134 public com.liferay.portal.model.Layout updatePriority(long groupId, 1135 boolean privateLayout, long layoutId, long nextLayoutId, 1136 long previousLayoutId) 1137 throws com.liferay.portal.kernel.exception.PortalException, 1138 com.liferay.portal.kernel.exception.SystemException; 1139 1140 /** 1141 * Updates the priority of the layout matching the primary key. 1142 * 1143 * @param plid the primary key of the layout 1144 * @param priority the layout's new priority 1145 * @return the updated layout 1146 * @throws PortalException if a layout with the primary key could not be 1147 found 1148 * @throws SystemException if a system exception occurred 1149 */ 1150 public com.liferay.portal.model.Layout updatePriority(long plid, 1151 int priority) 1152 throws com.liferay.portal.kernel.exception.PortalException, 1153 com.liferay.portal.kernel.exception.SystemException; 1154 1155 public com.liferay.portal.kernel.lar.MissingReferences validateImportLayoutsFile( 1156 long groupId, boolean privateLayout, 1157 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1158 java.io.File file) 1159 throws com.liferay.portal.kernel.exception.PortalException, 1160 com.liferay.portal.kernel.exception.SystemException; 1161 1162 public com.liferay.portal.kernel.lar.MissingReferences validateImportLayoutsFile( 1163 long groupId, boolean privateLayout, 1164 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1165 java.io.InputStream inputStream) 1166 throws com.liferay.portal.kernel.exception.PortalException, 1167 com.liferay.portal.kernel.exception.SystemException; 1168 1169 public com.liferay.portal.kernel.lar.MissingReferences validateImportPortletInfo( 1170 long plid, long groupId, java.lang.String portletId, 1171 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1172 java.io.File file) 1173 throws com.liferay.portal.kernel.exception.PortalException, 1174 com.liferay.portal.kernel.exception.SystemException; 1175 1176 public com.liferay.portal.kernel.lar.MissingReferences validateImportPortletInfo( 1177 long plid, long groupId, java.lang.String portletId, 1178 java.util.Map<java.lang.String, java.lang.String[]> parameterMap, 1179 java.io.InputStream inputStream) 1180 throws com.liferay.portal.kernel.exception.PortalException, 1181 com.liferay.portal.kernel.exception.SystemException; 1182 }