001 /** 002 * Copyright (c) 2000-2013 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.portlet.documentlibrary.service; 016 017 import com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.jsonwebservice.JSONWebService; 020 import com.liferay.portal.kernel.transaction.Isolation; 021 import com.liferay.portal.kernel.transaction.Propagation; 022 import com.liferay.portal.kernel.transaction.Transactional; 023 import com.liferay.portal.security.ac.AccessControlled; 024 import com.liferay.portal.service.BaseService; 025 026 /** 027 * Provides the remote service interface for DLApp. Methods of this 028 * service are expected to have security checks based on the propagated JAAS 029 * credentials because this service can be accessed remotely. 030 * 031 * @author Brian Wing Shun Chan 032 * @see DLAppServiceUtil 033 * @see com.liferay.portlet.documentlibrary.service.base.DLAppServiceBaseImpl 034 * @see com.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl 035 * @generated 036 */ 037 @AccessControlled 038 @JSONWebService 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface DLAppService extends BaseService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. Always use {@link DLAppServiceUtil} to access the d l app remote service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 046 */ 047 048 /** 049 * Returns the Spring bean ID for this bean. 050 * 051 * @return the Spring bean ID for this bean 052 */ 053 public java.lang.String getBeanIdentifier(); 054 055 /** 056 * Sets the Spring bean ID for this bean. 057 * 058 * @param beanIdentifier the Spring bean ID for this bean 059 */ 060 public void setBeanIdentifier(java.lang.String beanIdentifier); 061 062 /** 063 * Adds a file entry and associated metadata. It is created based on a byte 064 * array. 065 * 066 * <p> 067 * This method takes two file names, the <code>sourceFileName</code> and the 068 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 069 * name of the actual file being uploaded. The <code>title</code> 070 * corresponds to a name the client wishes to assign this file after it has 071 * been uploaded to the portal. If it is <code>null</code>, the <code> 072 * sourceFileName</code> will be used. 073 * </p> 074 * 075 * @param repositoryId the primary key of the repository 076 * @param folderId the primary key of the file entry's parent folder 077 * @param sourceFileName the original file's name 078 * @param mimeType the file's MIME type 079 * @param title the name to be assigned to the file (optionally <code>null 080 </code>) 081 * @param description the file's description 082 * @param changeLog the file's version change log 083 * @param bytes the file's data (optionally <code>null</code>) 084 * @param serviceContext the service context to be applied. Can set the 085 asset category IDs, asset tag names, and expando bridge 086 attributes for the file entry. In a Liferay repository, it may 087 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 088 type </li> <li> fieldsMap - mapping for fields associated with a 089 custom file entry type </li> </ul> 090 * @return the file entry 091 * @throws PortalException if the parent folder could not be found or if the 092 file entry's information was invalid 093 * @throws SystemException if a system exception occurred 094 */ 095 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 096 long repositoryId, long folderId, java.lang.String sourceFileName, 097 java.lang.String mimeType, java.lang.String title, 098 java.lang.String description, java.lang.String changeLog, byte[] bytes, 099 com.liferay.portal.service.ServiceContext serviceContext) 100 throws com.liferay.portal.kernel.exception.PortalException, 101 com.liferay.portal.kernel.exception.SystemException; 102 103 /** 104 * Adds a file entry and associated metadata. It is created based on a 105 * {@link java.io.File} object. 106 * 107 * <p> 108 * This method takes two file names, the <code>sourceFileName</code> and the 109 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 110 * name of the actual file being uploaded. The <code>title</code> 111 * corresponds to a name the client wishes to assign this file after it has 112 * been uploaded to the portal. If it is <code>null</code>, the <code> 113 * sourceFileName</code> will be used. 114 * </p> 115 * 116 * @param repositoryId the primary key of the repository 117 * @param folderId the primary key of the file entry's parent folder 118 * @param sourceFileName the original file's name 119 * @param mimeType the file's MIME type 120 * @param title the name to be assigned to the file (optionally <code>null 121 </code>) 122 * @param description the file's description 123 * @param changeLog the file's version change log 124 * @param file the file's data (optionally <code>null</code>) 125 * @param serviceContext the service context to be applied. Can set the 126 asset category IDs, asset tag names, and expando bridge 127 attributes for the file entry. In a Liferay repository, it may 128 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 129 type </li> <li> fieldsMap - mapping for fields associated with a 130 custom file entry type </li> </ul> 131 * @return the file entry 132 * @throws PortalException if the parent folder could not be found or if the 133 file entry's information was invalid 134 * @throws SystemException if a system exception occurred 135 */ 136 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 137 long repositoryId, long folderId, java.lang.String sourceFileName, 138 java.lang.String mimeType, java.lang.String title, 139 java.lang.String description, java.lang.String changeLog, 140 java.io.File file, 141 com.liferay.portal.service.ServiceContext serviceContext) 142 throws com.liferay.portal.kernel.exception.PortalException, 143 com.liferay.portal.kernel.exception.SystemException; 144 145 /** 146 * Adds a file entry and associated metadata. It is created based on a 147 * {@link java.io.InputStream} object. 148 * 149 * <p> 150 * This method takes two file names, the <code>sourceFileName</code> and the 151 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 152 * name of the actual file being uploaded. The <code>title</code> 153 * corresponds to a name the client wishes to assign this file after it has 154 * been uploaded to the portal. If it is <code>null</code>, the <code> 155 * sourceFileName</code> will be used. 156 * </p> 157 * 158 * @param repositoryId the primary key of the repository 159 * @param folderId the primary key of the file entry's parent folder 160 * @param sourceFileName the original file's name 161 * @param mimeType the file's MIME type 162 * @param title the name to be assigned to the file (optionally <code>null 163 </code>) 164 * @param description the file's description 165 * @param changeLog the file's version change log 166 * @param is the file's data (optionally <code>null</code>) 167 * @param size the file's size (optionally <code>0</code>) 168 * @param serviceContext the service context to be applied. Can set the 169 asset category IDs, asset tag names, and expando bridge 170 attributes for the file entry. In a Liferay repository, it may 171 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 172 type </li> <li> fieldsMap - mapping for fields associated with a 173 custom file entry type </li> </ul> 174 * @return the file entry 175 * @throws PortalException if the parent folder could not be found or if the 176 file entry's information was invalid 177 * @throws SystemException if a system exception occurred 178 */ 179 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 180 long repositoryId, long folderId, java.lang.String sourceFileName, 181 java.lang.String mimeType, java.lang.String title, 182 java.lang.String description, java.lang.String changeLog, 183 java.io.InputStream is, long size, 184 com.liferay.portal.service.ServiceContext serviceContext) 185 throws com.liferay.portal.kernel.exception.PortalException, 186 com.liferay.portal.kernel.exception.SystemException; 187 188 /** 189 * Adds a file shortcut to the existing file entry. This method is only 190 * supported by the Liferay repository. 191 * 192 * @param repositoryId the primary key of the repository 193 * @param folderId the primary key of the file shortcut's parent folder 194 * @param toFileEntryId the primary key of the file shortcut's file entry 195 * @param serviceContext the service context to be applied. Can set the 196 asset category IDs, asset tag names, and expando bridge 197 attributes for the file entry. 198 * @return the file shortcut 199 * @throws PortalException if the parent folder or file entry could not be 200 found, or if the file shortcut's information was invalid 201 * @throws SystemException if a system exception occurred 202 */ 203 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 204 long repositoryId, long folderId, long toFileEntryId, 205 com.liferay.portal.service.ServiceContext serviceContext) 206 throws com.liferay.portal.kernel.exception.PortalException, 207 com.liferay.portal.kernel.exception.SystemException; 208 209 /** 210 * Adds a folder. 211 * 212 * @param repositoryId the primary key of the repository 213 * @param parentFolderId the primary key of the folder's parent folder 214 * @param name the folder's name 215 * @param description the folder's description 216 * @param serviceContext the service context to be applied. In a Liferay 217 repository, it may include boolean mountPoint specifying whether 218 folder is a facade for mounting a third-party repository 219 * @return the folder 220 * @throws PortalException if the parent folder could not be found or if the 221 new folder's information was invalid 222 * @throws SystemException if a system exception occurred 223 */ 224 public com.liferay.portal.kernel.repository.model.Folder addFolder( 225 long repositoryId, long parentFolderId, java.lang.String name, 226 java.lang.String description, 227 com.liferay.portal.service.ServiceContext serviceContext) 228 throws com.liferay.portal.kernel.exception.PortalException, 229 com.liferay.portal.kernel.exception.SystemException; 230 231 /** 232 * Adds a temporary file entry. 233 * 234 * <p> 235 * This allows a client to upload a file into a temporary location and 236 * manipulate its metadata prior to making it available for public usage. 237 * This is different from checking in and checking out a file entry. 238 * </p> 239 * 240 * @param groupId the primary key of the group 241 * @param folderId the primary key of the folder where the file entry will 242 eventually reside 243 * @param fileName the file's original name 244 * @param tempFolderName the temporary folder's name 245 * @param file Name the file's original name 246 * @param mimeType the file's MIME type 247 * @return the file's name 248 * @throws PortalException if the file name was invalid 249 * @throws SystemException if a system exception occurred 250 * @see com.liferay.portal.kernel.util.TempFileUtil 251 */ 252 public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry( 253 long groupId, long folderId, java.lang.String fileName, 254 java.lang.String tempFolderName, java.io.File file, 255 java.lang.String mimeType) 256 throws com.liferay.portal.kernel.exception.PortalException, 257 com.liferay.portal.kernel.exception.SystemException; 258 259 public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry( 260 long groupId, long folderId, java.lang.String fileName, 261 java.lang.String tempFolderName, java.io.InputStream inputStream, 262 java.lang.String mimeType) 263 throws com.liferay.portal.kernel.exception.PortalException, 264 com.liferay.portal.kernel.exception.SystemException; 265 266 /** 267 * Cancels the check out of the file entry. If a user has not checked out 268 * the specified file entry, invoking this method will result in no changes. 269 * 270 * <p> 271 * When a file entry is checked out, a PWC (private working copy) is created 272 * and the original file entry is locked. A client can make as many changes 273 * to the PWC as he desires without those changes being visible to other 274 * users. If the user is satisfied with the changes, he may elect to check 275 * in his changes, resulting in a new file version based on the PWC; the PWC 276 * will be removed and the file entry will be unlocked. If the user is not 277 * satisfied with the changes, he may elect to cancel his check out; this 278 * results in the deletion of the PWC and unlocking of the file entry. 279 * </p> 280 * 281 * @param fileEntryId the primary key of the file entry to cancel the 282 checkout 283 * @throws PortalException if the file entry could not be found 284 * @throws SystemException if a system exception occurred 285 * @see #checkInFileEntry(long, boolean, String, ServiceContext) 286 * @see #checkOutFileEntry(long, ServiceContext) 287 */ 288 public void cancelCheckOut(long fileEntryId) 289 throws com.liferay.portal.kernel.exception.PortalException, 290 com.liferay.portal.kernel.exception.SystemException; 291 292 /** 293 * Checks in the file entry. If a user has not checked out the specified 294 * file entry, invoking this method will result in no changes. 295 * 296 * <p> 297 * When a file entry is checked out, a PWC (private working copy) is created 298 * and the original file entry is locked. A client can make as many changes 299 * to the PWC as he desires without those changes being visible to other 300 * users. If the user is satisfied with the changes, he may elect to check 301 * in his changes, resulting in a new file version based on the PWC; the PWC 302 * will be removed and the file entry will be unlocked. If the user is not 303 * satisfied with the changes, he may elect to cancel his check out; this 304 * results in the deletion of the PWC and unlocking of the file entry. 305 * </p> 306 * 307 * @param fileEntryId the primary key of the file entry to check in 308 * @param majorVersion whether the new file version is a major version 309 * @param changeLog the file's version change log 310 * @param serviceContext the service context to be applied 311 * @throws PortalException if the file entry could not be found 312 * @throws SystemException if a system exception occurred 313 * @see #cancelCheckOut(long) 314 * @see #checkOutFileEntry(long, ServiceContext) 315 */ 316 public void checkInFileEntry(long fileEntryId, boolean majorVersion, 317 java.lang.String changeLog, 318 com.liferay.portal.service.ServiceContext serviceContext) 319 throws com.liferay.portal.kernel.exception.PortalException, 320 com.liferay.portal.kernel.exception.SystemException; 321 322 /** 323 * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long, 324 String, ServiceContext)} 325 */ 326 public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid) 327 throws com.liferay.portal.kernel.exception.PortalException, 328 com.liferay.portal.kernel.exception.SystemException; 329 330 /** 331 * Checks in the file entry using the lock's UUID. If a user has not checked 332 * out the specified file entry, invoking this method will result in no 333 * changes. This method is primarily used by WebDAV. 334 * 335 * <p> 336 * When a file entry is checked out, a PWC (private working copy) is created 337 * and the original file entry is locked. A client can make as many changes 338 * to the PWC as he desires without those changes being visible to other 339 * users. If the user is satisfied with the changes, he may elect to check 340 * in his changes, resulting in a new file version based on the PWC; the PWC 341 * will be removed and the file entry will be unlocked. If the user is not 342 * satisfied with the changes, he may elect to cancel his check out; this 343 * results in the deletion of the PWC and unlocking of the file entry. 344 * </p> 345 * 346 * @param fileEntryId the primary key of the file entry to check in 347 * @param lockUuid the lock's UUID 348 * @param serviceContext the service context to be applied 349 * @throws PortalException if the file entry could not be found 350 * @throws SystemException if a system exception occurred 351 * @see #cancelCheckOut(long) 352 * @see #checkOutFileEntry(long, String, long, ServiceContext) 353 */ 354 public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid, 355 com.liferay.portal.service.ServiceContext serviceContext) 356 throws com.liferay.portal.kernel.exception.PortalException, 357 com.liferay.portal.kernel.exception.SystemException; 358 359 /** 360 * Check out a file entry. 361 * 362 * <p> 363 * When a file entry is checked out, a PWC (private working copy) is created 364 * and the original file entry is locked. A client can make as many changes 365 * to the PWC as he desires without those changes being visible to other 366 * users. If the user is satisfied with the changes, he may elect to check 367 * in his changes, resulting in a new file version based on the PWC; the PWC 368 * will be removed and the file entry will be unlocked. If the user is not 369 * satisfied with the changes, he may elect to cancel his check out; this 370 * results in the deletion of the PWC and unlocking of the file entry. 371 * </p> 372 * 373 * @param fileEntryId the file entry to check out 374 * @param serviceContext the service context to be applied 375 * @throws PortalException if the file entry could not be found 376 * @throws SystemException if a system exception occurred 377 * @see #cancelCheckOut(long) 378 * @see #checkInFileEntry(long, boolean, String, ServiceContext) 379 */ 380 public void checkOutFileEntry(long fileEntryId, 381 com.liferay.portal.service.ServiceContext serviceContext) 382 throws com.liferay.portal.kernel.exception.PortalException, 383 com.liferay.portal.kernel.exception.SystemException; 384 385 /** 386 * Checks out the file entry. This method is primarily used by WebDAV. 387 * 388 * <p> 389 * When a file entry is checked out, a PWC (private working copy) is created 390 * and the original file entry is locked. A client can make as many changes 391 * to the PWC as he desires without those changes being visible to other 392 * users. If the user is satisfied with the changes, he may elect to check 393 * in his changes, resulting in a new file version based on the PWC; the PWC 394 * will be removed and the file entry will be unlocked. If the user is not 395 * satisfied with the changes, he may elect to cancel his check out; this 396 * results in the deletion of the PWC and unlocking of the file entry. 397 * </p> 398 * 399 * @param fileEntryId the file entry to check out 400 * @param owner the owner string for the checkout (optionally 401 <code>null</code>) 402 * @param expirationTime the time in milliseconds before the lock expires. 403 If the value is <code>0</code>, the default expiration time will 404 be used from <code>portal.properties>. 405 * @param serviceContext the service context to be applied 406 * @return the file entry 407 * @throws PortalException if the file entry could not be found 408 * @throws SystemException if a system exception occurred 409 * @see #cancelCheckOut(long) 410 * @see #checkInFileEntry(long, String) 411 */ 412 public com.liferay.portal.kernel.repository.model.FileEntry checkOutFileEntry( 413 long fileEntryId, java.lang.String owner, long expirationTime, 414 com.liferay.portal.service.ServiceContext serviceContext) 415 throws com.liferay.portal.kernel.exception.PortalException, 416 com.liferay.portal.kernel.exception.SystemException; 417 418 /** 419 * Performs a deep copy of the folder. 420 * 421 * @param repositoryId the primary key of the repository 422 * @param sourceFolderId the primary key of the folder to copy 423 * @param parentFolderId the primary key of the new folder's parent folder 424 * @param name the new folder's name 425 * @param description the new folder's description 426 * @param serviceContext the service context to be applied 427 * @return the folder 428 * @throws PortalException if the source folder or the new parent folder 429 could not be found or if the new folder's information was invalid 430 * @throws SystemException if a system exception occurred 431 */ 432 public com.liferay.portal.kernel.repository.model.Folder copyFolder( 433 long repositoryId, long sourceFolderId, long parentFolderId, 434 java.lang.String name, java.lang.String description, 435 com.liferay.portal.service.ServiceContext serviceContext) 436 throws com.liferay.portal.kernel.exception.PortalException, 437 com.liferay.portal.kernel.exception.SystemException; 438 439 /** 440 * Deletes the file entry with the primary key. 441 * 442 * @param fileEntryId the primary key of the file entry 443 * @throws PortalException if the file entry could not be found 444 * @throws SystemException if a system exception occurred 445 */ 446 public void deleteFileEntry(long fileEntryId) 447 throws com.liferay.portal.kernel.exception.PortalException, 448 com.liferay.portal.kernel.exception.SystemException; 449 450 /** 451 * Deletes the file entry with the title in the folder. 452 * 453 * @param repositoryId the primary key of the repository 454 * @param folderId the primary key of the file entry's parent folder 455 * @param title the file entry's title 456 * @throws PortalException if the file entry could not be found 457 * @throws SystemException if a system exception occurred 458 */ 459 public void deleteFileEntryByTitle(long repositoryId, long folderId, 460 java.lang.String title) 461 throws com.liferay.portal.kernel.exception.PortalException, 462 com.liferay.portal.kernel.exception.SystemException; 463 464 /** 465 * Deletes the file shortcut with the primary key. This method is only 466 * supported by the Liferay repository. 467 * 468 * @param fileShortcutId the primary key of the file shortcut 469 * @throws PortalException if the file shortcut could not be found 470 * @throws SystemException if a system exception occurred 471 */ 472 public void deleteFileShortcut(long fileShortcutId) 473 throws com.liferay.portal.kernel.exception.PortalException, 474 com.liferay.portal.kernel.exception.SystemException; 475 476 /** 477 * Deletes the file version. File versions can only be deleted if it is 478 * approved and there are other approved file versions available. This 479 * method is only supported by the Liferay repository. 480 * 481 * @param fileEntryId the primary key of the file entry 482 * @param version the version label of the file version 483 * @throws PortalException if the file version could not be found or invalid 484 * @throws SystemException if a system exception occurred 485 */ 486 public void deleteFileVersion(long fileEntryId, java.lang.String version) 487 throws com.liferay.portal.kernel.exception.PortalException, 488 com.liferay.portal.kernel.exception.SystemException; 489 490 /** 491 * Deletes the folder with the primary key and all of its subfolders and 492 * file entries. 493 * 494 * @param folderId the primary key of the folder 495 * @throws PortalException if the folder could not be found 496 * @throws SystemException if a system exception occurred 497 */ 498 public void deleteFolder(long folderId) 499 throws com.liferay.portal.kernel.exception.PortalException, 500 com.liferay.portal.kernel.exception.SystemException; 501 502 /** 503 * Deletes the folder with the name in the parent folder and all of its 504 * subfolders and file entries. 505 * 506 * @param repositoryId the primary key of the repository 507 * @param parentFolderId the primary key of the folder's parent folder 508 * @param name the folder's name 509 * @throws PortalException if the folder could not be found 510 * @throws SystemException if a system exception occurred 511 */ 512 public void deleteFolder(long repositoryId, long parentFolderId, 513 java.lang.String name) 514 throws com.liferay.portal.kernel.exception.PortalException, 515 com.liferay.portal.kernel.exception.SystemException; 516 517 /** 518 * Deletes the temporary file entry. 519 * 520 * @param groupId the primary key of the group 521 * @param folderId the primary key of the folder where the file entry was 522 eventually to reside 523 * @param fileName the file's original name 524 * @param tempFolderName the temporary folder's name 525 * @throws PortalException if the file name was invalid 526 * @throws SystemException if a system exception occurred 527 * @see com.liferay.portal.kernel.util.TempFileUtil 528 */ 529 public void deleteTempFileEntry(long groupId, long folderId, 530 java.lang.String fileName, java.lang.String tempFolderName) 531 throws com.liferay.portal.kernel.exception.PortalException, 532 com.liferay.portal.kernel.exception.SystemException; 533 534 /** 535 * Returns all the file entries in the folder. 536 * 537 * @param repositoryId the primary key of the file entry's repository 538 * @param folderId the primary key of the file entry's folder 539 * @return the file entries in the folder 540 * @throws PortalException if the folder could not be found 541 * @throws SystemException if a system exception occurred 542 */ 543 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 544 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 545 long repositoryId, long folderId) 546 throws com.liferay.portal.kernel.exception.PortalException, 547 com.liferay.portal.kernel.exception.SystemException; 548 549 /** 550 * Returns a range of all the file entries in the folder. 551 * 552 * <p> 553 * Useful when paginating results. Returns a maximum of <code>end - 554 * start</code> instances. <code>start</code> and <code>end</code> are not 555 * primary keys, they are indexes in the result set. Thus, <code>0</code> 556 * refers to the first result in the set. Setting both <code>start</code> 557 * and <code>end</code> to {@link 558 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 559 * result set. 560 * </p> 561 * 562 * @param repositoryId the primary key of the file entry's repository 563 * @param folderId the primary key of the file entry's folder 564 * @param start the lower bound of the range of results 565 * @param end the upper bound of the range of results (not inclusive) 566 * @return the range of file entries in the folder 567 * @throws PortalException if the folder could not be found 568 * @throws SystemException if a system exception occurred 569 */ 570 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 571 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 572 long repositoryId, long folderId, int start, int end) 573 throws com.liferay.portal.kernel.exception.PortalException, 574 com.liferay.portal.kernel.exception.SystemException; 575 576 /** 577 * Returns an ordered range of all the file entries in the folder. 578 * 579 * <p> 580 * Useful when paginating results. Returns a maximum of <code>end - 581 * start</code> instances. <code>start</code> and <code>end</code> are not 582 * primary keys, they are indexes in the result set. Thus, <code>0</code> 583 * refers to the first result in the set. Setting both <code>start</code> 584 * and <code>end</code> to {@link 585 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 586 * result set. 587 * </p> 588 * 589 * @param repositoryId the primary key of the file entry's repository 590 * @param folderId the primary key of the file entry's folder 591 * @param start the lower bound of the range of results 592 * @param end the upper bound of the range of results (not inclusive) 593 * @param obc the comparator to order the file entries (optionally 594 <code>null</code>) 595 * @return the range of file entries in the folder ordered by comparator 596 <code>obc</code> 597 * @throws PortalException if the folder could not be found 598 * @throws SystemException if a system exception occurred 599 */ 600 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 601 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 602 long repositoryId, long folderId, int start, int end, 603 com.liferay.portal.kernel.util.OrderByComparator obc) 604 throws com.liferay.portal.kernel.exception.PortalException, 605 com.liferay.portal.kernel.exception.SystemException; 606 607 /** 608 * Returns the file entries with the file entry type in the folder. 609 * 610 * @param repositoryId the primary key of the file entry's repository 611 * @param folderId the primary key of the file entry's folder 612 * @param fileEntryTypeId the primary key of the file entry type 613 * @return the file entries with the file entry type in the folder 614 * @throws PortalException if the folder could not be found 615 * @throws SystemException if a system exception occurred 616 */ 617 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 618 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 619 long repositoryId, long folderId, long fileEntryTypeId) 620 throws com.liferay.portal.kernel.exception.PortalException, 621 com.liferay.portal.kernel.exception.SystemException; 622 623 /** 624 * Returns a range of all the file entries with the file entry type in the 625 * folder. 626 * 627 * @param repositoryId the primary key of the file entry's repository 628 * @param folderId the primary key of the file entry's folder 629 * @param fileEntryTypeId the primary key of the file entry type 630 * @param start the lower bound of the range of results 631 * @param end the upper bound of the range of results (not inclusive) 632 * @return the file entries in the folder 633 * @throws PortalException if the folder could not be found 634 * @throws SystemException if a system exception occurred 635 */ 636 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 637 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 638 long repositoryId, long folderId, long fileEntryTypeId, int start, 639 int end) 640 throws com.liferay.portal.kernel.exception.PortalException, 641 com.liferay.portal.kernel.exception.SystemException; 642 643 /** 644 * Returns an ordered range of all the file entries with the file entry type 645 * in the folder. 646 * 647 * @param repositoryId the primary key of the repository 648 * @param folderId the primary key of the folder 649 * @param fileEntryTypeId the primary key of the file entry type 650 * @param start the lower bound of the range of results 651 * @param end the upper bound of the range of results (not inclusive) 652 * @param obc the comparator to order the results by (optionally 653 <code>null</code>) 654 * @return the range of file entries with the file entry type in the folder 655 ordered by <code>null</code> 656 * @throws PortalException if the folder could not be found 657 * @throws SystemException if a system exception occurred 658 */ 659 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 660 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 661 long repositoryId, long folderId, long fileEntryTypeId, int start, 662 int end, com.liferay.portal.kernel.util.OrderByComparator obc) 663 throws com.liferay.portal.kernel.exception.PortalException, 664 com.liferay.portal.kernel.exception.SystemException; 665 666 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 667 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 668 long repositoryId, long folderId, java.lang.String[] mimeTypes) 669 throws com.liferay.portal.kernel.exception.PortalException, 670 com.liferay.portal.kernel.exception.SystemException; 671 672 /** 673 * Returns a range of all the file entries and shortcuts in the folder. 674 * 675 * <p> 676 * Useful when paginating results. Returns a maximum of <code>end - 677 * start</code> instances. <code>start</code> and <code>end</code> are not 678 * primary keys, they are indexes in the result set. Thus, <code>0</code> 679 * refers to the first result in the set. Setting both <code>start</code> 680 * and <code>end</code> to {@link 681 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 682 * result set. 683 * </p> 684 * 685 * @param repositoryId the primary key of the repository 686 * @param folderId the primary key of the folder 687 * @param status the workflow status 688 * @param start the lower bound of the range of results 689 * @param end the upper bound of the range of results (not inclusive) 690 * @return the range of file entries and shortcuts in the folder 691 * @throws PortalException if the folder could not be found 692 * @throws SystemException if a system exception occurred 693 */ 694 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 695 public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts( 696 long repositoryId, long folderId, int status, int start, int end) 697 throws com.liferay.portal.kernel.exception.PortalException, 698 com.liferay.portal.kernel.exception.SystemException; 699 700 /** 701 * Returns the number of file entries and shortcuts in the folder. 702 * 703 * @param repositoryId the primary key of the repository 704 * @param folderId the primary key of the folder 705 * @param status the workflow status 706 * @return the number of file entries and shortcuts in the folder 707 * @throws PortalException if the folder ould not be found 708 * @throws SystemException if a system exception occurred 709 */ 710 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 711 public int getFileEntriesAndFileShortcutsCount(long repositoryId, 712 long folderId, int status) 713 throws com.liferay.portal.kernel.exception.PortalException, 714 com.liferay.portal.kernel.exception.SystemException; 715 716 /** 717 * Returns the number of file entries and shortcuts in the folder. 718 * 719 * @param repositoryId the primary key of the repository 720 * @param folderId the primary key of the folder 721 * @param status the workflow status 722 * @param mimeTypes allowed media types 723 * @return the number of file entries and shortcuts in the folder 724 * @throws PortalException if the folder ould not be found 725 * @throws SystemException if a system exception occurred 726 */ 727 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 728 public int getFileEntriesAndFileShortcutsCount(long repositoryId, 729 long folderId, int status, java.lang.String[] mimeTypes) 730 throws com.liferay.portal.kernel.exception.PortalException, 731 com.liferay.portal.kernel.exception.SystemException; 732 733 /** 734 * Returns the number of file entries in the folder. 735 * 736 * @param repositoryId the primary key of the file entry's repository 737 * @param folderId the primary key of the file entry's folder 738 * @return the number of file entries in the folder 739 * @throws PortalException if the folder could not be found 740 * @throws SystemException if a system exception occurred 741 */ 742 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 743 public int getFileEntriesCount(long repositoryId, long folderId) 744 throws com.liferay.portal.kernel.exception.PortalException, 745 com.liferay.portal.kernel.exception.SystemException; 746 747 /** 748 * Returns the number of file entries with the file entry type in the 749 * folder. 750 * 751 * @param repositoryId the primary key of the file entry's repository 752 * @param folderId the primary key of the file entry's folder 753 * @param fileEntryTypeId the primary key of the file entry type 754 * @return the number of file entries with the file entry type in the folder 755 * @throws PortalException if the folder could not be found 756 * @throws SystemException if a system exception occurred 757 */ 758 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 759 public int getFileEntriesCount(long repositoryId, long folderId, 760 long fileEntryTypeId) 761 throws com.liferay.portal.kernel.exception.PortalException, 762 com.liferay.portal.kernel.exception.SystemException; 763 764 /** 765 * Returns the file entry with the primary key. 766 * 767 * @param fileEntryId the primary key of the file entry 768 * @return the file entry with the primary key 769 * @throws PortalException if the file entry could not be found 770 * @throws SystemException if a system exception occurred 771 */ 772 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 773 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 774 long fileEntryId) 775 throws com.liferay.portal.kernel.exception.PortalException, 776 com.liferay.portal.kernel.exception.SystemException; 777 778 /** 779 * Returns the file entry with the title in the folder. 780 * 781 * @param groupId the primary key of the file entry's group 782 * @param folderId the primary key of the file entry's folder 783 * @param title the file entry's title 784 * @return the file entry with the title in the folder 785 * @throws PortalException if the file entry could not be found 786 * @throws SystemException if a system exception occurred 787 */ 788 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 789 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 790 long groupId, long folderId, java.lang.String title) 791 throws com.liferay.portal.kernel.exception.PortalException, 792 com.liferay.portal.kernel.exception.SystemException; 793 794 /** 795 * Returns the file entry with the UUID and group. 796 * 797 * @param uuid the file entry's UUID 798 * @param groupId the primary key of the file entry's group 799 * @return the file entry with the UUID and group 800 * @throws PortalException if the file entry could not be found 801 * @throws SystemException if a system exception occurred 802 */ 803 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 804 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId( 805 java.lang.String uuid, long groupId) 806 throws com.liferay.portal.kernel.exception.PortalException, 807 com.liferay.portal.kernel.exception.SystemException; 808 809 /** 810 * Returns the file shortcut with the primary key. This method is only 811 * supported by the Liferay repository. 812 * 813 * @param fileShortcutId the primary key of the file shortcut 814 * @return the file shortcut with the primary key 815 * @throws PortalException if the file shortcut could not be found 816 * @throws SystemException if a system exception occurred 817 */ 818 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 819 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 820 long fileShortcutId) 821 throws com.liferay.portal.kernel.exception.PortalException, 822 com.liferay.portal.kernel.exception.SystemException; 823 824 /** 825 * Returns the folder with the primary key. 826 * 827 * @param folderId the primary key of the folder 828 * @return the folder with the primary key 829 * @throws PortalException if the folder could not be found 830 * @throws SystemException if a system exception occurred 831 */ 832 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 833 public com.liferay.portal.kernel.repository.model.Folder getFolder( 834 long folderId) 835 throws com.liferay.portal.kernel.exception.PortalException, 836 com.liferay.portal.kernel.exception.SystemException; 837 838 /** 839 * Returns the folder with the name in the parent folder. 840 * 841 * @param repositoryId the primary key of the folder's repository 842 * @param parentFolderId the primary key of the folder's parent folder 843 * @param name the folder's name 844 * @return the folder with the name in the parent folder 845 * @throws PortalException if the folder could not be found 846 * @throws SystemException if a system exception occurred 847 */ 848 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 849 public com.liferay.portal.kernel.repository.model.Folder getFolder( 850 long repositoryId, long parentFolderId, java.lang.String name) 851 throws com.liferay.portal.kernel.exception.PortalException, 852 com.liferay.portal.kernel.exception.SystemException; 853 854 /** 855 * Returns all immediate subfolders of the parent folder. 856 * 857 * @param repositoryId the primary key of the folder's repository 858 * @param parentFolderId the primary key of the folder's parent folder 859 * @return the immediate subfolders of the parent folder 860 * @throws PortalException if the parent folder could not be found 861 * @throws SystemException if a system exception occurred 862 */ 863 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 864 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 865 long repositoryId, long parentFolderId) 866 throws com.liferay.portal.kernel.exception.PortalException, 867 com.liferay.portal.kernel.exception.SystemException; 868 869 /** 870 * Returns all immediate subfolders of the parent folder, optionally 871 * including mount folders for third-party repositories. 872 * 873 * @param repositoryId the primary key of the folder's repository 874 * @param parentFolderId the primary key of the folder's parent folder 875 * @param includeMountFolders whether to include mount folders for 876 third-party repositories 877 * @return the immediate subfolders of the parent folder 878 * @throws PortalException if the parent folder could not be found 879 * @throws SystemException if a system exception occurred 880 */ 881 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 882 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 883 long repositoryId, long parentFolderId, boolean includeMountFolders) 884 throws com.liferay.portal.kernel.exception.PortalException, 885 com.liferay.portal.kernel.exception.SystemException; 886 887 /** 888 * Returns a range of all the immediate subfolders of the parent folder, 889 * optionally including mount folders for third-party repositories. 890 * 891 * <p> 892 * Useful when paginating results. Returns a maximum of <code>end - 893 * start</code> instances. <code>start</code> and <code>end</code> are not 894 * primary keys, they are indexes in the result set. Thus, <code>0</code> 895 * refers to the first result in the set. Setting both <code>start</code> 896 * and <code>end</code> to {@link 897 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 898 * result set. 899 * </p> 900 * 901 * @param repositoryId the primary key of the folder's repository 902 * @param parentFolderId the primary key of the folder's parent folder 903 * @param includeMountFolders whether to include mount folders for 904 third-party repositories 905 * @param start the lower bound of the range of results 906 * @param end the upper bound of the range of results (not inclusive) 907 * @return the range of immediate subfolders of the parent folder 908 * @throws PortalException if the parent folder could not be found 909 * @throws SystemException if a system exception occurred 910 */ 911 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 912 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 913 long repositoryId, long parentFolderId, boolean includeMountFolders, 914 int start, int end) 915 throws com.liferay.portal.kernel.exception.PortalException, 916 com.liferay.portal.kernel.exception.SystemException; 917 918 /** 919 * Returns an ordered range of all the immediate subfolders of the parent 920 * folder. 921 * 922 * <p> 923 * Useful when paginating results. Returns a maximum of <code>end - 924 * start</code> instances. <code>start</code> and <code>end</code> are not 925 * primary keys, they are indexes in the result set. Thus, <code>0</code> 926 * refers to the first result in the set. Setting both <code>start</code> 927 * and <code>end</code> to {@link 928 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 929 * result set. 930 * </p> 931 * 932 * @param repositoryId the primary key of the folder's repository 933 * @param parentFolderId the primary key of the folder's parent folder 934 * @param includeMountFolders whether to include mount folders for 935 third-party repositories 936 * @param start the lower bound of the range of results 937 * @param end the upper bound of the range of results (not inclusive) 938 * @param obc the comparator to order the folders (optionally 939 <code>null</code>) 940 * @return the range of immediate subfolders of the parent folder ordered by 941 comparator <code>obc</code> 942 * @throws PortalException if the parent folder could not be found 943 * @throws SystemException if a system exception occurred 944 */ 945 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 946 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 947 long repositoryId, long parentFolderId, boolean includeMountFolders, 948 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 949 throws com.liferay.portal.kernel.exception.PortalException, 950 com.liferay.portal.kernel.exception.SystemException; 951 952 /** 953 * Returns an ordered range of all the immediate subfolders of the parent 954 * folder. 955 * 956 * <p> 957 * Useful when paginating results. Returns a maximum of <code>end - 958 * start</code> instances. <code>start</code> and <code>end</code> are not 959 * primary keys, they are indexes in the result set. Thus, <code>0</code> 960 * refers to the first result in the set. Setting both <code>start</code> 961 * and <code>end</code> to {@link 962 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 963 * result set. 964 * </p> 965 * 966 * @param repositoryId the primary key of the folder's repository 967 * @param parentFolderId the primary key of the folder's parent folder 968 * @param status the workflow status 969 * @param includeMountFolders whether to include mount folders for 970 third-party repositories 971 * @param start the lower bound of the range of results 972 * @param end the upper bound of the range of results (not inclusive) 973 * @param obc the comparator to order the folders (optionally 974 <code>null</code>) 975 * @return the range of immediate subfolders of the parent folder ordered by 976 comparator <code>obc</code> 977 * @throws PortalException if the parent folder could not be found 978 * @throws SystemException if a system exception occurred 979 */ 980 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 981 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 982 long repositoryId, long parentFolderId, int status, 983 boolean includeMountFolders, int start, int end, 984 com.liferay.portal.kernel.util.OrderByComparator obc) 985 throws com.liferay.portal.kernel.exception.PortalException, 986 com.liferay.portal.kernel.exception.SystemException; 987 988 /** 989 * Returns a range of all the immediate subfolders of the parent folder. 990 * 991 * <p> 992 * Useful when paginating results. Returns a maximum of <code>end - 993 * start</code> instances. <code>start</code> and <code>end</code> are not 994 * primary keys, they are indexes in the result set. Thus, <code>0</code> 995 * refers to the first result in the set. Setting both <code>start</code> 996 * and <code>end</code> to {@link 997 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 998 * result set. 999 * </p> 1000 * 1001 * @param repositoryId the primary key of the folder's repository 1002 * @param parentFolderId the primary key of the folder's parent folder 1003 * @param start the lower bound of the range of results 1004 * @param end the upper bound of the range of results (not inclusive) 1005 * @return the range of immediate subfolders of the parent folder 1006 * @throws PortalException if the parent folder could not be found 1007 * @throws SystemException if a system exception occurred 1008 */ 1009 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1010 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1011 long repositoryId, long parentFolderId, int start, int end) 1012 throws com.liferay.portal.kernel.exception.PortalException, 1013 com.liferay.portal.kernel.exception.SystemException; 1014 1015 /** 1016 * Returns an ordered range of all the immediate subfolders of the parent 1017 * folder. 1018 * 1019 * <p> 1020 * Useful when paginating results. Returns a maximum of <code>end - 1021 * start</code> instances. <code>start</code> and <code>end</code> are not 1022 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1023 * refers to the first result in the set. Setting both <code>start</code> 1024 * and <code>end</code> to {@link 1025 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1026 * result set. 1027 * </p> 1028 * 1029 * @param repositoryId the primary key of the folder's repository 1030 * @param parentFolderId the primary key of the folder's parent folder 1031 * @param start the lower bound of the range of results 1032 * @param end the upper bound of the range of results (not inclusive) 1033 * @param obc the comparator to order the folders (optionally 1034 <code>null</code>) 1035 * @return the range of immediate subfolders of the parent folder ordered by 1036 comparator <code>obc</code> 1037 * @throws PortalException if the parent folder could not be found 1038 * @throws SystemException if a system exception occurred 1039 */ 1040 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1041 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1042 long repositoryId, long parentFolderId, int start, int end, 1043 com.liferay.portal.kernel.util.OrderByComparator obc) 1044 throws com.liferay.portal.kernel.exception.PortalException, 1045 com.liferay.portal.kernel.exception.SystemException; 1046 1047 /** 1048 * Returns a range of all the immediate subfolders, file entries, and file 1049 * shortcuts in the parent folder. 1050 * 1051 * <p> 1052 * Useful when paginating results. Returns a maximum of <code>end - 1053 * start</code> instances. <code>start</code> and <code>end</code> are not 1054 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1055 * refers to the first result in the set. Setting both <code>start</code> 1056 * and <code>end</code> to {@link 1057 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1058 * result set. 1059 * </p> 1060 * 1061 * @param repositoryId the primary key of the repository 1062 * @param folderId the primary key of the parent folder 1063 * @param status the workflow status 1064 * @param includeMountFolders whether to include mount folders for 1065 third-party repositories 1066 * @param start the lower bound of the range of results 1067 * @param end the upper bound of the range of results (not inclusive) 1068 * @return the range of immediate subfolders, file entries, and file 1069 shortcuts in the parent folder ordered by comparator 1070 <code>obc</code> 1071 * @throws PortalException if the parent folder could not be found 1072 * @throws SystemException if a system exception occurred 1073 */ 1074 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1075 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1076 long repositoryId, long folderId, int status, 1077 boolean includeMountFolders, int start, int end) 1078 throws com.liferay.portal.kernel.exception.PortalException, 1079 com.liferay.portal.kernel.exception.SystemException; 1080 1081 /** 1082 * Returns an ordered range of all the immediate subfolders, file entries, 1083 * and file shortcuts in the parent folder. 1084 * 1085 * <p> 1086 * Useful when paginating results. Returns a maximum of <code>end - 1087 * start</code> instances. <code>start</code> and <code>end</code> are not 1088 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1089 * refers to the first result in the set. Setting both <code>start</code> 1090 * and <code>end</code> to {@link 1091 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1092 * result set. 1093 * </p> 1094 * 1095 * @param repositoryId the primary key of the repository 1096 * @param folderId the primary key of the parent folder 1097 * @param status the workflow status 1098 * @param includeMountFolders whether to include mount folders for 1099 third-party repositories 1100 * @param start the lower bound of the range of results 1101 * @param end the upper bound of the range of results (not inclusive) 1102 * @param obc the comparator to order the results (optionally 1103 <code>null</code>) 1104 * @return the range of immediate subfolders, file entries, and file 1105 shortcuts in the parent folder ordered by comparator 1106 <code>obc</code> 1107 * @throws PortalException if the parent folder could not be found 1108 * @throws SystemException if a system exception occurred 1109 */ 1110 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1111 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1112 long repositoryId, long folderId, int status, 1113 boolean includeMountFolders, int start, int end, 1114 com.liferay.portal.kernel.util.OrderByComparator obc) 1115 throws com.liferay.portal.kernel.exception.PortalException, 1116 com.liferay.portal.kernel.exception.SystemException; 1117 1118 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1119 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1120 long repositoryId, long folderId, int status, 1121 java.lang.String[] mimeTypes, boolean includeMountFolders, int start, 1122 int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1123 throws com.liferay.portal.kernel.exception.PortalException, 1124 com.liferay.portal.kernel.exception.SystemException; 1125 1126 /** 1127 * Returns the number of immediate subfolders, file entries, and file 1128 * shortcuts in the parent folder. 1129 * 1130 * @param repositoryId the primary key of the repository 1131 * @param folderId the primary key of the parent folder 1132 * @param status the workflow status 1133 * @param includeMountFolders whether to include mount folders for 1134 third-party repositories 1135 * @return the number of immediate subfolders, file entries, and file 1136 shortcuts in the parent folder 1137 * @throws PortalException if the folder could not be found 1138 * @throws SystemException if a system exception occurred 1139 */ 1140 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1141 public int getFoldersAndFileEntriesAndFileShortcutsCount( 1142 long repositoryId, long folderId, int status, 1143 boolean includeMountFolders) 1144 throws com.liferay.portal.kernel.exception.PortalException, 1145 com.liferay.portal.kernel.exception.SystemException; 1146 1147 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1148 public int getFoldersAndFileEntriesAndFileShortcutsCount( 1149 long repositoryId, long folderId, int status, 1150 java.lang.String[] mimeTypes, boolean includeMountFolders) 1151 throws com.liferay.portal.kernel.exception.PortalException, 1152 com.liferay.portal.kernel.exception.SystemException; 1153 1154 /** 1155 * Returns the number of immediate subfolders of the parent folder. 1156 * 1157 * @param repositoryId the primary key of the folder's repository 1158 * @param parentFolderId the primary key of the folder's parent folder 1159 * @return the number of immediate subfolders of the parent folder 1160 * @throws PortalException if the parent folder could not be found 1161 * @throws SystemException if a system exception occurred 1162 */ 1163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1164 public int getFoldersCount(long repositoryId, long parentFolderId) 1165 throws com.liferay.portal.kernel.exception.PortalException, 1166 com.liferay.portal.kernel.exception.SystemException; 1167 1168 /** 1169 * Returns the number of immediate subfolders of the parent folder, 1170 * optionally including mount folders for third-party repositories. 1171 * 1172 * @param repositoryId the primary key of the folder's repository 1173 * @param parentFolderId the primary key of the folder's parent folder 1174 * @param includeMountFolders whether to include mount folders for 1175 third-party repositories 1176 * @return the number of immediate subfolders of the parent folder 1177 * @throws PortalException if the parent folder could not be found 1178 * @throws SystemException if a system exception occurred 1179 */ 1180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1181 public int getFoldersCount(long repositoryId, long parentFolderId, 1182 boolean includeMountFolders) 1183 throws com.liferay.portal.kernel.exception.PortalException, 1184 com.liferay.portal.kernel.exception.SystemException; 1185 1186 /** 1187 * Returns the number of immediate subfolders of the parent folder, 1188 * optionally including mount folders for third-party repositories. 1189 * 1190 * @param repositoryId the primary key of the folder's repository 1191 * @param parentFolderId the primary key of the folder's parent folder 1192 * @param status the workflow status 1193 * @param includeMountFolders whether to include mount folders for 1194 third-party repositories 1195 * @return the number of immediate subfolders of the parent folder 1196 * @throws PortalException if the parent folder could not be found 1197 * @throws SystemException if a system exception occurred 1198 */ 1199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1200 public int getFoldersCount(long repositoryId, long parentFolderId, 1201 int status, boolean includeMountFolders) 1202 throws com.liferay.portal.kernel.exception.PortalException, 1203 com.liferay.portal.kernel.exception.SystemException; 1204 1205 /** 1206 * Returns the number of immediate subfolders and file entries across the 1207 * folders. 1208 * 1209 * @param repositoryId the primary key of the repository 1210 * @param folderIds the primary keys of folders from which to count 1211 immediate subfolders and file entries 1212 * @param status the workflow status 1213 * @return the number of immediate subfolders and file entries across the 1214 folders 1215 * @throws PortalException if the repository could not be found 1216 * @throws SystemException if a system exception occurred 1217 */ 1218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1219 public int getFoldersFileEntriesCount(long repositoryId, 1220 java.util.List<java.lang.Long> folderIds, int status) 1221 throws com.liferay.portal.kernel.exception.PortalException, 1222 com.liferay.portal.kernel.exception.SystemException; 1223 1224 /** 1225 * Returns an ordered range of all the file entries in the group starting at 1226 * the repository default parent folder that are stored within the Liferay 1227 * repository. This method is primarily used to search for recently modified 1228 * file entries. It can be limited to the file entries modified by a given 1229 * user. 1230 * 1231 * <p> 1232 * Useful when paginating results. Returns a maximum of <code>end - 1233 * start</code> instances. <code>start</code> and <code>end</code> are not 1234 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1235 * refers to the first result in the set. Setting both <code>start</code> 1236 * and <code>end</code> to {@link 1237 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1238 * result set. 1239 * </p> 1240 * 1241 * @param groupId the primary key of the group 1242 * @param userId the primary key of the user who created the file 1243 (optionally <code>0</code>) 1244 * @param start the lower bound of the range of results 1245 * @param end the upper bound of the range of results (not inclusive) 1246 * @return the range of matching file entries ordered by date modified 1247 * @throws PortalException if the group could not be found 1248 * @throws SystemException if a system exception occurred 1249 */ 1250 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1251 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1252 long groupId, long userId, int start, int end) 1253 throws com.liferay.portal.kernel.exception.PortalException, 1254 com.liferay.portal.kernel.exception.SystemException; 1255 1256 /** 1257 * Returns an ordered range of all the file entries in the group that are 1258 * stored within the Liferay repository. This method is primarily used to 1259 * search for recently modified file entries. It can be limited to the file 1260 * entries modified by a given user. 1261 * 1262 * <p> 1263 * Useful when paginating results. Returns a maximum of <code>end - 1264 * start</code> instances. <code>start</code> and <code>end</code> are not 1265 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1266 * refers to the first result in the set. Setting both <code>start</code> 1267 * and <code>end</code> to {@link 1268 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1269 * result set. 1270 * </p> 1271 * 1272 * @param groupId the primary key of the group 1273 * @param userId the primary key of the user who created the file 1274 (optionally <code>0</code>) 1275 * @param start the lower bound of the range of results 1276 * @param end the upper bound of the range of results (not inclusive) 1277 * @param obc the comparator to order the file entries (optionally 1278 <code>null</code>) 1279 * @return the range of matching file entries ordered by comparator 1280 <code>obc</code> 1281 * @throws PortalException if the group could not be found 1282 * @throws SystemException if a system exception occurred 1283 */ 1284 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1285 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1286 long groupId, long userId, int start, int end, 1287 com.liferay.portal.kernel.util.OrderByComparator obc) 1288 throws com.liferay.portal.kernel.exception.PortalException, 1289 com.liferay.portal.kernel.exception.SystemException; 1290 1291 /** 1292 * Returns an ordered range of all the file entries in the group starting at 1293 * the root folder that are stored within the Liferay repository. This 1294 * method is primarily used to search for recently modified file entries. It 1295 * can be limited to the file entries modified by a given user. 1296 * 1297 * <p> 1298 * Useful when paginating results. Returns a maximum of <code>end - 1299 * start</code> instances. <code>start</code> and <code>end</code> are not 1300 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1301 * refers to the first result in the set. Setting both <code>start</code> 1302 * and <code>end</code> to {@link 1303 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1304 * result set. 1305 * </p> 1306 * 1307 * @param groupId the primary key of the group 1308 * @param userId the primary key of the user who created the file 1309 (optionally <code>0</code>) 1310 * @param rootFolderId the primary key of the root folder to begin the 1311 search 1312 * @param start the lower bound of the range of results 1313 * @param end the upper bound of the range of results (not inclusive) 1314 * @return the range of matching file entries ordered by date modified 1315 * @throws PortalException if the group could not be found 1316 * @throws SystemException if a system exception occurred 1317 */ 1318 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1319 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1320 long groupId, long userId, long rootFolderId, int start, int end) 1321 throws com.liferay.portal.kernel.exception.PortalException, 1322 com.liferay.portal.kernel.exception.SystemException; 1323 1324 /** 1325 * Returns an ordered range of all the file entries in the group starting at 1326 * the root folder that are stored within the Liferay repository. This 1327 * method is primarily used to search for recently modified file entries. It 1328 * can be limited to the file entries modified by a given user. 1329 * 1330 * <p> 1331 * Useful when paginating results. Returns a maximum of <code>end - 1332 * start</code> instances. <code>start</code> and <code>end</code> are not 1333 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1334 * refers to the first result in the set. Setting both <code>start</code> 1335 * and <code>end</code> to {@link 1336 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1337 * result set. 1338 * </p> 1339 * 1340 * @param groupId the primary key of the group 1341 * @param userId the primary key of the user who created the file 1342 (optionally <code>0</code>) 1343 * @param rootFolderId the primary key of the root folder to begin the 1344 search 1345 * @param start the lower bound of the range of results 1346 * @param end the upper bound of the range of results (not inclusive) 1347 * @param obc the comparator to order the file entries (optionally 1348 <code>null</code>) 1349 * @return the range of matching file entries ordered by comparator 1350 <code>obc</code> 1351 * @throws PortalException if the group could not be found 1352 * @throws SystemException if a system exception occurred 1353 */ 1354 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1355 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1356 long groupId, long userId, long rootFolderId, int start, int end, 1357 com.liferay.portal.kernel.util.OrderByComparator obc) 1358 throws com.liferay.portal.kernel.exception.PortalException, 1359 com.liferay.portal.kernel.exception.SystemException; 1360 1361 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1362 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1363 long groupId, long userId, long rootFolderId, 1364 java.lang.String[] mimeTypes, int status, int start, int end, 1365 com.liferay.portal.kernel.util.OrderByComparator obc) 1366 throws com.liferay.portal.kernel.exception.PortalException, 1367 com.liferay.portal.kernel.exception.SystemException; 1368 1369 /** 1370 * Returns the number of file entries in a group starting at the repository 1371 * default parent folder that are stored within the Liferay repository. This 1372 * method is primarily used to search for recently modified file entries. It 1373 * can be limited to the file entries modified by a given user. 1374 * 1375 * @param groupId the primary key of the group 1376 * @param userId the primary key of the user who created the file 1377 (optionally <code>0</code>) 1378 * @return the number of matching file entries 1379 * @throws PortalException if the group could not be found 1380 * @throws SystemException if a system exception occurred 1381 */ 1382 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1383 public int getGroupFileEntriesCount(long groupId, long userId) 1384 throws com.liferay.portal.kernel.exception.PortalException, 1385 com.liferay.portal.kernel.exception.SystemException; 1386 1387 /** 1388 * Returns the number of file entries in a group starting at the root folder 1389 * that are stored within the Liferay repository. This method is primarily 1390 * used to search for recently modified file entries. It can be limited to 1391 * the file entries modified by a given user. 1392 * 1393 * @param groupId the primary key of the group 1394 * @param userId the primary key of the user who created the file 1395 (optionally <code>0</code>) 1396 * @param rootFolderId the primary key of the root folder to begin the 1397 search 1398 * @return the number of matching file entries 1399 * @throws PortalException if the group could not be found 1400 * @throws SystemException if a system exception occurred 1401 */ 1402 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1403 public int getGroupFileEntriesCount(long groupId, long userId, 1404 long rootFolderId) 1405 throws com.liferay.portal.kernel.exception.PortalException, 1406 com.liferay.portal.kernel.exception.SystemException; 1407 1408 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1409 public int getGroupFileEntriesCount(long groupId, long userId, 1410 long rootFolderId, java.lang.String[] mimeTypes, int status) 1411 throws com.liferay.portal.kernel.exception.PortalException, 1412 com.liferay.portal.kernel.exception.SystemException; 1413 1414 /** 1415 * Returns all immediate subfolders of the parent folder that are used for 1416 * mounting third-party repositories. This method is only supported by the 1417 * Liferay repository. 1418 * 1419 * @param repositoryId the primary key of the folder's repository 1420 * @param parentFolderId the primary key of the folder's parent folder 1421 * @return the immediate subfolders of the parent folder that are used for 1422 mounting third-party repositories 1423 * @throws PortalException if the repository or parent folder could not be 1424 found 1425 * @throws SystemException if a system exception occurred 1426 */ 1427 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1428 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1429 long repositoryId, long parentFolderId) 1430 throws com.liferay.portal.kernel.exception.PortalException, 1431 com.liferay.portal.kernel.exception.SystemException; 1432 1433 /** 1434 * Returns a range of all the immediate subfolders of the parent folder that 1435 * are used for mounting third-party repositories. This method is only 1436 * supported by the Liferay repository. 1437 * 1438 * <p> 1439 * Useful when paginating results. Returns a maximum of <code>end - 1440 * start</code> instances. <code>start</code> and <code>end</code> are not 1441 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1442 * refers to the first result in the set. Setting both <code>start</code> 1443 * and <code>end</code> to {@link 1444 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1445 * result set. 1446 * </p> 1447 * 1448 * @param repositoryId the primary key of the repository 1449 * @param parentFolderId the primary key of the parent folder 1450 * @param start the lower bound of the range of results 1451 * @param end the upper bound of the range of results (not inclusive) 1452 * @return the range of immediate subfolders of the parent folder that are 1453 used for mounting third-party repositories 1454 * @throws PortalException if the repository or parent folder could not be 1455 found 1456 * @throws SystemException if a system exception occurred 1457 */ 1458 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1459 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1460 long repositoryId, long parentFolderId, int start, int end) 1461 throws com.liferay.portal.kernel.exception.PortalException, 1462 com.liferay.portal.kernel.exception.SystemException; 1463 1464 /** 1465 * Returns an ordered range of all the immediate subfolders of the parent 1466 * folder that are used for mounting third-party repositories. This method 1467 * is only supported by the Liferay repository. 1468 * 1469 * <p> 1470 * Useful when paginating results. Returns a maximum of <code>end - 1471 * start</code> instances. <code>start</code> and <code>end</code> are not 1472 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1473 * refers to the first result in the set. Setting both <code>start</code> 1474 * and <code>end</code> to {@link 1475 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1476 * result set. 1477 * </p> 1478 * 1479 * @param repositoryId the primary key of the folder's repository 1480 * @param parentFolderId the primary key of the folder's parent folder 1481 * @param start the lower bound of the range of results 1482 * @param end the upper bound of the range of results (not inclusive) 1483 * @param obc the comparator to order the folders (optionally 1484 <code>null</code>) 1485 * @return the range of immediate subfolders of the parent folder that are 1486 used for mounting third-party repositories ordered by comparator 1487 <code>obc</code> 1488 * @throws PortalException if the repository or parent folder could not be 1489 found 1490 * @throws SystemException if a system exception occurred 1491 */ 1492 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1493 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1494 long repositoryId, long parentFolderId, int start, int end, 1495 com.liferay.portal.kernel.util.OrderByComparator obc) 1496 throws com.liferay.portal.kernel.exception.PortalException, 1497 com.liferay.portal.kernel.exception.SystemException; 1498 1499 /** 1500 * Returns the number of immediate subfolders of the parent folder that are 1501 * used for mounting third-party repositories. This method is only supported 1502 * by the Liferay repository. 1503 * 1504 * @param repositoryId the primary key of the repository 1505 * @param parentFolderId the primary key of the parent folder 1506 * @return the number of folders of the parent folder that are used for 1507 mounting third-party repositories 1508 * @throws PortalException if the repository or parent folder could not be 1509 found 1510 * @throws SystemException if a system exception occurred 1511 */ 1512 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1513 public int getMountFoldersCount(long repositoryId, long parentFolderId) 1514 throws com.liferay.portal.kernel.exception.PortalException, 1515 com.liferay.portal.kernel.exception.SystemException; 1516 1517 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1518 public void getSubfolderIds(long repositoryId, 1519 java.util.List<java.lang.Long> folderIds, long folderId) 1520 throws com.liferay.portal.kernel.exception.PortalException, 1521 com.liferay.portal.kernel.exception.SystemException; 1522 1523 /** 1524 * Returns all the descendant folders of the folder with the primary key. 1525 * 1526 * @param repositoryId the primary key of the repository 1527 * @param folderId the primary key of the folder 1528 * @return the descendant folders of the folder with the primary key 1529 * @throws PortalException if the repository or parent folder could not be 1530 found 1531 * @throws SystemException if a system exception occurred 1532 */ 1533 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1534 public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId, 1535 long folderId) 1536 throws com.liferay.portal.kernel.exception.PortalException, 1537 com.liferay.portal.kernel.exception.SystemException; 1538 1539 /** 1540 * Returns descendant folders of the folder with the primary key, optionally 1541 * limiting to one level deep. 1542 * 1543 * @param repositoryId the primary key of the repository 1544 * @param folderId the primary key of the folder 1545 * @param recurse whether to recurse through each subfolder 1546 * @return the descendant folders of the folder with the primary key 1547 * @throws PortalException if the repository or parent folder could not be 1548 found 1549 * @throws SystemException if a system exception occurred 1550 */ 1551 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1552 public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId, 1553 long folderId, boolean recurse) 1554 throws com.liferay.portal.kernel.exception.PortalException, 1555 com.liferay.portal.kernel.exception.SystemException; 1556 1557 /** 1558 * Returns all the temporary file entry names. 1559 * 1560 * @param groupId the primary key of the group 1561 * @param folderId the primary key of the folder where the file entry will 1562 eventually reside 1563 * @param tempFolderName the temporary folder's name 1564 * @return the temporary file entry names 1565 * @throws PortalException if the folder was invalid 1566 * @throws SystemException if a system exception occurred 1567 * @see #addTempFileEntry(long, long, String, String, File, String) 1568 * @see com.liferay.portal.kernel.util.TempFileUtil 1569 */ 1570 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1571 public java.lang.String[] getTempFileEntryNames(long groupId, 1572 long folderId, java.lang.String tempFolderName) 1573 throws com.liferay.portal.kernel.exception.PortalException, 1574 com.liferay.portal.kernel.exception.SystemException; 1575 1576 /** 1577 * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long, 1578 ServiceContext)} 1579 */ 1580 public com.liferay.portal.model.Lock lockFileEntry(long fileEntryId) 1581 throws com.liferay.portal.kernel.exception.PortalException, 1582 com.liferay.portal.kernel.exception.SystemException; 1583 1584 /** 1585 * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long, 1586 String, long, ServiceContext)} 1587 */ 1588 public com.liferay.portal.model.Lock lockFileEntry(long fileEntryId, 1589 java.lang.String owner, long expirationTime) 1590 throws com.liferay.portal.kernel.exception.PortalException, 1591 com.liferay.portal.kernel.exception.SystemException; 1592 1593 /** 1594 * Locks the folder. This method is primarily used by WebDAV. 1595 * 1596 * @param repositoryId the primary key of the repository 1597 * @param folderId the primary key of the folder 1598 * @return the lock object 1599 * @throws PortalException if the repository or folder could not be found 1600 * @throws SystemException if a system exception occurred 1601 */ 1602 public com.liferay.portal.model.Lock lockFolder(long repositoryId, 1603 long folderId) 1604 throws com.liferay.portal.kernel.exception.PortalException, 1605 com.liferay.portal.kernel.exception.SystemException; 1606 1607 /** 1608 * Locks the folder. This method is primarily used by WebDAV. 1609 * 1610 * @param repositoryId the primary key of the repository 1611 * @param folderId the primary key of the folder 1612 * @param owner the owner string for the checkout (optionally 1613 <code>null</code>) 1614 * @param inheritable whether the lock must propagate to descendants 1615 * @param expirationTime the time in milliseconds before the lock expires. 1616 If the value is <code>0</code>, the default expiration time will 1617 be used from <code>portal.properties>. 1618 * @return the lock object 1619 * @throws PortalException if the repository or folder could not be found 1620 * @throws SystemException if a system exception occurred 1621 */ 1622 public com.liferay.portal.model.Lock lockFolder(long repositoryId, 1623 long folderId, java.lang.String owner, boolean inheritable, 1624 long expirationTime) 1625 throws com.liferay.portal.kernel.exception.PortalException, 1626 com.liferay.portal.kernel.exception.SystemException; 1627 1628 /** 1629 * Moves the file entry to the new folder. 1630 * 1631 * @param fileEntryId the primary key of the file entry 1632 * @param newFolderId the primary key of the new folder 1633 * @param serviceContext the service context to be applied 1634 * @return the file entry 1635 * @throws PortalException if the file entry or the new folder could not be 1636 found 1637 * @throws SystemException if a system exception occurred 1638 */ 1639 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry( 1640 long fileEntryId, long newFolderId, 1641 com.liferay.portal.service.ServiceContext serviceContext) 1642 throws com.liferay.portal.kernel.exception.PortalException, 1643 com.liferay.portal.kernel.exception.SystemException; 1644 1645 /** 1646 * Moves the file entry from a trashed folder to the new folder. 1647 * 1648 * @param fileEntryId the primary key of the file entry 1649 * @param newFolderId the primary key of the new folder 1650 * @param serviceContext the service context to be applied 1651 * @return the file entry 1652 * @throws PortalException if the file entry or the new folder could not be 1653 found 1654 * @throws SystemException if a system exception occurred 1655 */ 1656 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryFromTrash( 1657 long fileEntryId, long newFolderId, 1658 com.liferay.portal.service.ServiceContext serviceContext) 1659 throws com.liferay.portal.kernel.exception.PortalException, 1660 com.liferay.portal.kernel.exception.SystemException; 1661 1662 /** 1663 * Moves the file entry with the primary key to the trash portlet. 1664 * 1665 * @param fileEntryId the primary key of the file entry 1666 * @return the file entry 1667 * @throws PortalException if the file entry could not be found 1668 * @throws SystemException if a system exception occurred 1669 */ 1670 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash( 1671 long fileEntryId) 1672 throws com.liferay.portal.kernel.exception.PortalException, 1673 com.liferay.portal.kernel.exception.SystemException; 1674 1675 /** 1676 * Moves the file shortcut from a trashed folder to the new folder. 1677 * 1678 * @param fileShortcutId the primary key of the file shortcut 1679 * @param newFolderId the primary key of the new folder 1680 * @param serviceContext the service context to be applied 1681 * @return the file shortcut 1682 * @throws PortalException if the file entry or the new folder could not be 1683 found 1684 * @throws SystemException if a system exception occurred 1685 */ 1686 public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutFromTrash( 1687 long fileShortcutId, long newFolderId, 1688 com.liferay.portal.service.ServiceContext serviceContext) 1689 throws com.liferay.portal.kernel.exception.PortalException, 1690 com.liferay.portal.kernel.exception.SystemException; 1691 1692 /** 1693 * Moves the file shortcut with the primary key to the trash portlet. 1694 * 1695 * @param fileShortcutId the primary key of the file shortcut 1696 * @return the file shortcut 1697 * @throws PortalException if the file shortcut could not be found 1698 * @throws SystemException if a system exception occurred 1699 */ 1700 public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutToTrash( 1701 long fileShortcutId) 1702 throws com.liferay.portal.kernel.exception.PortalException, 1703 com.liferay.portal.kernel.exception.SystemException; 1704 1705 /** 1706 * Moves the folder to the new parent folder with the primary key. 1707 * 1708 * @param folderId the primary key of the folder 1709 * @param parentFolderId the primary key of the new parent folder 1710 * @param serviceContext the service context to be applied 1711 * @return the file entry 1712 * @throws PortalException if the folder could not be found 1713 * @throws SystemException if a system exception occurred 1714 */ 1715 public com.liferay.portal.kernel.repository.model.Folder moveFolder( 1716 long folderId, long parentFolderId, 1717 com.liferay.portal.service.ServiceContext serviceContext) 1718 throws com.liferay.portal.kernel.exception.PortalException, 1719 com.liferay.portal.kernel.exception.SystemException; 1720 1721 /** 1722 * Moves the folder with the primary key from the trash portlet to the new 1723 * parent folder with the primary key. 1724 * 1725 * @param folderId the primary key of the folder 1726 * @param parentFolderId the primary key of the new parent folder 1727 * @param serviceContext the service context to be applied 1728 * @return the file entry 1729 * @throws PortalException if the folder could not be found 1730 * @throws SystemException if a system exception occurred 1731 */ 1732 public com.liferay.portal.kernel.repository.model.Folder moveFolderFromTrash( 1733 long folderId, long parentFolderId, 1734 com.liferay.portal.service.ServiceContext serviceContext) 1735 throws com.liferay.portal.kernel.exception.PortalException, 1736 com.liferay.portal.kernel.exception.SystemException; 1737 1738 /** 1739 * Moves the folder with the primary key to the trash portlet. 1740 * 1741 * @param folderId the primary key of the folder 1742 * @return the file entry 1743 * @throws PortalException if the folder could not be found 1744 * @throws SystemException if a system exception occurred 1745 */ 1746 public com.liferay.portal.kernel.repository.model.Folder moveFolderToTrash( 1747 long folderId) 1748 throws com.liferay.portal.kernel.exception.PortalException, 1749 com.liferay.portal.kernel.exception.SystemException; 1750 1751 /** 1752 * Refreshes the lock for the file entry. This method is primarily used by 1753 * WebDAV. 1754 * 1755 * @param lockUuid the lock's UUID 1756 * @param companyId the primary key of the file entry's company 1757 * @param expirationTime the time in milliseconds before the lock expires. 1758 If the value is <code>0</code>, the default expiration time will 1759 be used from <code>portal.properties>. 1760 * @return the lock object 1761 * @throws PortalException if the file entry or lock could not be found 1762 * @throws SystemException if a system exception occurred 1763 */ 1764 public com.liferay.portal.model.Lock refreshFileEntryLock( 1765 java.lang.String lockUuid, long companyId, long expirationTime) 1766 throws com.liferay.portal.kernel.exception.PortalException, 1767 com.liferay.portal.kernel.exception.SystemException; 1768 1769 /** 1770 * Refreshes the lock for the folder. This method is primarily used by 1771 * WebDAV. 1772 * 1773 * @param lockUuid the lock's UUID 1774 * @param companyId the primary key of the file entry's company 1775 * @param expirationTime the time in milliseconds before the lock expires. 1776 If the value is <code>0</code>, the default expiration time will 1777 be used from <code>portal.properties>. 1778 * @return the lock object 1779 * @throws PortalException if the folder or lock could not be found 1780 * @throws SystemException if a system exception occurred 1781 */ 1782 public com.liferay.portal.model.Lock refreshFolderLock( 1783 java.lang.String lockUuid, long companyId, long expirationTime) 1784 throws com.liferay.portal.kernel.exception.PortalException, 1785 com.liferay.portal.kernel.exception.SystemException; 1786 1787 /** 1788 * Restores the file entry with the primary key from the trash portlet. 1789 * 1790 * @param fileEntryId the primary key of the file entry 1791 * @throws PortalException if the file entry could not be found 1792 * @throws SystemException if a system exception occurred 1793 */ 1794 public void restoreFileEntryFromTrash(long fileEntryId) 1795 throws com.liferay.portal.kernel.exception.PortalException, 1796 com.liferay.portal.kernel.exception.SystemException; 1797 1798 /** 1799 * Restores the file shortcut with the primary key from the trash portlet. 1800 * 1801 * @param fileShortcutId the primary key of the file shortcut 1802 * @throws PortalException if the file shortcut could not be found 1803 * @throws SystemException if a system exception occurred 1804 */ 1805 public void restoreFileShortcutFromTrash(long fileShortcutId) 1806 throws com.liferay.portal.kernel.exception.PortalException, 1807 com.liferay.portal.kernel.exception.SystemException; 1808 1809 /** 1810 * Restores the folder with the primary key from the trash portlet. 1811 * 1812 * @param folderId the primary key of the folder 1813 * @throws PortalException if the folder could not be found 1814 * @throws SystemException if a system exception occurred 1815 */ 1816 public void restoreFolderFromTrash(long folderId) 1817 throws com.liferay.portal.kernel.exception.PortalException, 1818 com.liferay.portal.kernel.exception.SystemException; 1819 1820 /** 1821 * Reverts the file entry to a previous version. A new version will be 1822 * created based on the previous version and metadata. 1823 * 1824 * @param fileEntryId the primary key of the file entry 1825 * @param version the version to revert back to 1826 * @param serviceContext the service context to be applied 1827 * @throws PortalException if the file entry or version could not be found 1828 * @throws SystemException if a system exception occurred 1829 */ 1830 public void revertFileEntry(long fileEntryId, java.lang.String version, 1831 com.liferay.portal.service.ServiceContext serviceContext) 1832 throws com.liferay.portal.kernel.exception.PortalException, 1833 com.liferay.portal.kernel.exception.SystemException; 1834 1835 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1836 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 1837 long creatorUserId, int status, int start, int end) 1838 throws com.liferay.portal.kernel.exception.PortalException, 1839 com.liferay.portal.kernel.exception.SystemException; 1840 1841 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1842 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 1843 long creatorUserId, long folderId, java.lang.String[] mimeTypes, 1844 int status, int start, int end) 1845 throws com.liferay.portal.kernel.exception.PortalException, 1846 com.liferay.portal.kernel.exception.SystemException; 1847 1848 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1849 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 1850 com.liferay.portal.kernel.search.SearchContext searchContext) 1851 throws com.liferay.portal.kernel.search.SearchException; 1852 1853 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 1854 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 1855 com.liferay.portal.kernel.search.SearchContext searchContext, 1856 com.liferay.portal.kernel.search.Query query) 1857 throws com.liferay.portal.kernel.search.SearchException; 1858 1859 /** 1860 * Subscribe the user to changes in documents of the file entry type. This 1861 * method is only supported by the Liferay repository. 1862 * 1863 * @param groupId the primary key of the file entry type's group 1864 * @param fileEntryTypeId the primary key of the file entry type 1865 * @throws PortalException if the user or group could not be found, or if 1866 subscribing was not permissible 1867 * @throws SystemException if a system exception occurred 1868 */ 1869 public void subscribeFileEntryType(long groupId, long fileEntryTypeId) 1870 throws com.liferay.portal.kernel.exception.PortalException, 1871 com.liferay.portal.kernel.exception.SystemException; 1872 1873 /** 1874 * Subscribe the user to document changes in the folder. This method is only 1875 * supported by the Liferay repository. 1876 * 1877 * @param groupId the primary key of the folder's group 1878 * @param folderId the primary key of the folder 1879 * @throws PortalException if the user or group could not be found, or if 1880 subscribing was not permissible 1881 * @throws SystemException if a system exception occurred 1882 */ 1883 public void subscribeFolder(long groupId, long folderId) 1884 throws com.liferay.portal.kernel.exception.PortalException, 1885 com.liferay.portal.kernel.exception.SystemException; 1886 1887 /** 1888 * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long, 1889 boolean, String, ServiceContext)}. 1890 */ 1891 public void unlockFileEntry(long fileEntryId) 1892 throws com.liferay.portal.kernel.exception.PortalException, 1893 com.liferay.portal.kernel.exception.SystemException; 1894 1895 /** 1896 * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long, 1897 String)}. 1898 */ 1899 public void unlockFileEntry(long fileEntryId, java.lang.String lockUuid) 1900 throws com.liferay.portal.kernel.exception.PortalException, 1901 com.liferay.portal.kernel.exception.SystemException; 1902 1903 /** 1904 * Unlocks the folder. This method is primarily used by WebDAV. 1905 * 1906 * @param repositoryId the primary key of the repository 1907 * @param folderId the primary key of the folder 1908 * @param lockUuid the lock's UUID 1909 * @throws PortalException if the repository or folder could not be found 1910 * @throws SystemException if a system exception occurred 1911 */ 1912 public void unlockFolder(long repositoryId, long folderId, 1913 java.lang.String lockUuid) 1914 throws com.liferay.portal.kernel.exception.PortalException, 1915 com.liferay.portal.kernel.exception.SystemException; 1916 1917 /** 1918 * Unlocks the folder. This method is primarily used by WebDAV. 1919 * 1920 * @param repositoryId the primary key of the repository 1921 * @param parentFolderId the primary key of the parent folder 1922 * @param name the folder's name 1923 * @param lockUuid the lock's UUID 1924 * @throws PortalException if the repository or folder could not be found 1925 * @throws SystemException if a system exception occurred 1926 */ 1927 public void unlockFolder(long repositoryId, long parentFolderId, 1928 java.lang.String name, java.lang.String lockUuid) 1929 throws com.liferay.portal.kernel.exception.PortalException, 1930 com.liferay.portal.kernel.exception.SystemException; 1931 1932 /** 1933 * Unsubscribe the user from changes in documents of the file entry type. 1934 * This method is only supported by the Liferay repository. 1935 * 1936 * @param groupId the primary key of the file entry type's group 1937 * @param fileEntryTypeId the primary key of the file entry type 1938 * @throws PortalException if the user or group could not be found, or if 1939 unsubscribing was not permissible 1940 * @throws SystemException if a system exception occurred 1941 */ 1942 public void unsubscribeFileEntryType(long groupId, long fileEntryTypeId) 1943 throws com.liferay.portal.kernel.exception.PortalException, 1944 com.liferay.portal.kernel.exception.SystemException; 1945 1946 /** 1947 * Unsubscribe the user from document changes in the folder. This method is 1948 * only supported by the Liferay repository. 1949 * 1950 * @param groupId the primary key of the folder's group 1951 * @param folderId the primary key of the folder 1952 * @throws PortalException if the user or group could not be found, or if 1953 unsubscribing was not permissible 1954 * @throws SystemException if a system exception occurred 1955 */ 1956 public void unsubscribeFolder(long groupId, long folderId) 1957 throws com.liferay.portal.kernel.exception.PortalException, 1958 com.liferay.portal.kernel.exception.SystemException; 1959 1960 /** 1961 * Updates a file entry and associated metadata based on a byte array 1962 * object. If the file data is <code>null</code>, then only the associated 1963 * metadata (i.e., <code>title</code>, <code>description</code>, and 1964 * parameters in the <code>serviceContext</code>) will be updated. 1965 * 1966 * <p> 1967 * This method takes two file names, the <code>sourceFileName</code> and the 1968 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 1969 * name of the actual file being uploaded. The <code>title</code> 1970 * corresponds to a name the client wishes to assign this file after it has 1971 * been uploaded to the portal. 1972 * </p> 1973 * 1974 * @param fileEntryId the primary key of the file entry 1975 * @param sourceFileName the original file's name (optionally 1976 <code>null</code>) 1977 * @param mimeType the file's MIME type (optionally <code>null</code>) 1978 * @param title the new name to be assigned to the file (optionally <code> 1979 <code>null</code></code>) 1980 * @param description the file's new description 1981 * @param changeLog the file's version change log (optionally 1982 <code>null</code>) 1983 * @param majorVersion whether the new file version is a major version 1984 * @param bytes the file's data (optionally <code>null</code>) 1985 * @param serviceContext the service context to be applied. Can set the 1986 asset category IDs, asset tag names, and expando bridge 1987 attributes for the file entry. In a Liferay repository, it may 1988 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 1989 type </li> <li> fieldsMap - mapping for fields associated with a 1990 custom file entry type </li> </ul> 1991 * @return the file entry 1992 * @throws PortalException if the file entry could not be found 1993 * @throws SystemException if a system exception occurred 1994 */ 1995 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 1996 long fileEntryId, java.lang.String sourceFileName, 1997 java.lang.String mimeType, java.lang.String title, 1998 java.lang.String description, java.lang.String changeLog, 1999 boolean majorVersion, byte[] bytes, 2000 com.liferay.portal.service.ServiceContext serviceContext) 2001 throws com.liferay.portal.kernel.exception.PortalException, 2002 com.liferay.portal.kernel.exception.SystemException; 2003 2004 /** 2005 * Updates a file entry and associated metadata based on a {@link 2006 * java.io.File} object. If the file data is <code>null</code>, then only 2007 * the associated metadata (i.e., <code>title</code>, 2008 * <code>description</code>, and parameters in the 2009 * <code>serviceContext</code>) will be updated. 2010 * 2011 * <p> 2012 * This method takes two file names, the <code>sourceFileName</code> and the 2013 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 2014 * name of the actual file being uploaded. The <code>title</code> 2015 * corresponds to a name the client wishes to assign this file after it has 2016 * been uploaded to the portal. 2017 * </p> 2018 * 2019 * @param fileEntryId the primary key of the file entry 2020 * @param sourceFileName the original file's name (optionally 2021 <code>null</code>) 2022 * @param mimeType the file's MIME type (optionally <code>null</code>) 2023 * @param title the new name to be assigned to the file (optionally <code> 2024 <code>null</code></code>) 2025 * @param description the file's new description 2026 * @param changeLog the file's version change log (optionally 2027 <code>null</code>) 2028 * @param majorVersion whether the new file version is a major version 2029 * @param file EntryId the primary key of the file entry 2030 * @param serviceContext the service context to be applied. Can set the 2031 asset category IDs, asset tag names, and expando bridge 2032 attributes for the file entry. In a Liferay repository, it may 2033 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 2034 type </li> <li> fieldsMap - mapping for fields associated with a 2035 custom file entry type </li> </ul> 2036 * @return the file entry 2037 * @throws PortalException if the file entry could not be found 2038 * @throws SystemException if a system exception occurred 2039 */ 2040 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 2041 long fileEntryId, java.lang.String sourceFileName, 2042 java.lang.String mimeType, java.lang.String title, 2043 java.lang.String description, java.lang.String changeLog, 2044 boolean majorVersion, java.io.File file, 2045 com.liferay.portal.service.ServiceContext serviceContext) 2046 throws com.liferay.portal.kernel.exception.PortalException, 2047 com.liferay.portal.kernel.exception.SystemException; 2048 2049 /** 2050 * Updates a file entry and associated metadata based on an {@link java.io. 2051 * InputStream} object. If the file data is <code>null</code>, then only the 2052 * associated metadata (i.e., <code>title</code>, <code>description</code>, 2053 * and parameters in the <code>serviceContext</code>) will be updated. 2054 * 2055 * <p> 2056 * This method takes two file names, the <code>sourceFileName</code> and the 2057 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 2058 * name of the actual file being uploaded. The <code>title</code> 2059 * corresponds to a name the client wishes to assign this file after it has 2060 * been uploaded to the portal. 2061 * </p> 2062 * 2063 * @param fileEntryId the primary key of the file entry 2064 * @param sourceFileName the original file's name (optionally 2065 <code>null</code>) 2066 * @param mimeType the file's MIME type (optionally <code>null</code>) 2067 * @param title the new name to be assigned to the file (optionally <code> 2068 <code>null</code></code>) 2069 * @param description the file's new description 2070 * @param changeLog the file's version change log (optionally 2071 <code>null</code>) 2072 * @param majorVersion whether the new file version is a major version 2073 * @param is the file's data (optionally <code>null</code>) 2074 * @param size the file's size (optionally <code>0</code>) 2075 * @param serviceContext the service context to be applied. Can set the 2076 asset category IDs, asset tag names, and expando bridge 2077 attributes for the file entry. In a Liferay repository, it may 2078 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 2079 type </li> <li> fieldsMap - mapping for fields associated with a 2080 custom file entry type </li> </ul> 2081 * @return the file entry 2082 * @throws PortalException if the file entry could not be found 2083 * @throws SystemException if a system exception occurred 2084 */ 2085 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 2086 long fileEntryId, java.lang.String sourceFileName, 2087 java.lang.String mimeType, java.lang.String title, 2088 java.lang.String description, java.lang.String changeLog, 2089 boolean majorVersion, java.io.InputStream is, long size, 2090 com.liferay.portal.service.ServiceContext serviceContext) 2091 throws com.liferay.portal.kernel.exception.PortalException, 2092 com.liferay.portal.kernel.exception.SystemException; 2093 2094 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn( 2095 long fileEntryId, java.lang.String sourceFileName, 2096 java.lang.String mimeType, java.lang.String title, 2097 java.lang.String description, java.lang.String changeLog, 2098 boolean majorVersion, java.io.File file, 2099 com.liferay.portal.service.ServiceContext serviceContext) 2100 throws com.liferay.portal.kernel.exception.PortalException, 2101 com.liferay.portal.kernel.exception.SystemException; 2102 2103 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn( 2104 long fileEntryId, java.lang.String sourceFileName, 2105 java.lang.String mimeType, java.lang.String title, 2106 java.lang.String description, java.lang.String changeLog, 2107 boolean majorVersion, java.io.InputStream is, long size, 2108 com.liferay.portal.service.ServiceContext serviceContext) 2109 throws com.liferay.portal.kernel.exception.PortalException, 2110 com.liferay.portal.kernel.exception.SystemException; 2111 2112 /** 2113 * Updates a file shortcut to the existing file entry. This method is only 2114 * supported by the Liferay repository. 2115 * 2116 * @param fileShortcutId the primary key of the file shortcut 2117 * @param folderId the primary key of the file shortcut's parent folder 2118 * @param toFileEntryId the primary key of the file shortcut's file entry 2119 * @param serviceContext the service context to be applied. Can set the 2120 asset category IDs, asset tag names, and expando bridge 2121 attributes for the file entry. 2122 * @return the file shortcut 2123 * @throws PortalException if the file shortcut, folder, or file entry could 2124 not be found 2125 * @throws SystemException if a system exception occurred 2126 */ 2127 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 2128 long fileShortcutId, long folderId, long toFileEntryId, 2129 com.liferay.portal.service.ServiceContext serviceContext) 2130 throws com.liferay.portal.kernel.exception.PortalException, 2131 com.liferay.portal.kernel.exception.SystemException; 2132 2133 /** 2134 * Updates the folder. 2135 * 2136 * @param folderId the primary key of the folder 2137 * @param name the folder's new name 2138 * @param description the folder's new description 2139 * @param serviceContext the service context to be applied. In a Liferay 2140 repository, it may include: <ul> <li> defaultFileEntryTypeId - 2141 the file entry type to default all Liferay file entries to </li> 2142 <li> dlFileEntryTypesSearchContainerPrimaryKeys - a 2143 comma-delimited list of file entry type primary keys allowed in 2144 the given folder and all descendants </li> <li> 2145 overrideFileEntryTypes - boolean specifying whether to override 2146 ancestral folder's restriction of file entry types allowed </li> 2147 <li> workflowDefinitionXYZ - the workflow definition name 2148 specified per file entry type. The parameter name must be the 2149 string <code>workflowDefinition</code> appended by the <code> 2150 fileEntryTypeId</code> (optionally <code>0</code>). </li> </ul> 2151 * @return the folder 2152 * @throws PortalException if the current or new parent folder could not be 2153 found or if the new parent folder's information was invalid 2154 * @throws SystemException if a system exception occurred 2155 */ 2156 public com.liferay.portal.kernel.repository.model.Folder updateFolder( 2157 long folderId, java.lang.String name, java.lang.String description, 2158 com.liferay.portal.service.ServiceContext serviceContext) 2159 throws com.liferay.portal.kernel.exception.PortalException, 2160 com.liferay.portal.kernel.exception.SystemException; 2161 2162 /** 2163 * Returns <code>true</code> if the file entry is checked out. This method 2164 * is primarily used by WebDAV. 2165 * 2166 * @param repositoryId the primary key for the repository 2167 * @param fileEntryId the primary key for the file entry 2168 * @param lockUuid the lock's UUID 2169 * @return <code>true</code> if the file entry is checked out; 2170 <code>false</code> otherwise 2171 * @throws PortalException if the file entry could not be found 2172 * @throws SystemException if a system exception occurred 2173 */ 2174 public boolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId, 2175 java.lang.String lockUuid) 2176 throws com.liferay.portal.kernel.exception.PortalException, 2177 com.liferay.portal.kernel.exception.SystemException; 2178 2179 public boolean verifyFileEntryLock(long repositoryId, long fileEntryId, 2180 java.lang.String lockUuid) 2181 throws com.liferay.portal.kernel.exception.PortalException, 2182 com.liferay.portal.kernel.exception.SystemException; 2183 2184 /** 2185 * Returns <code>true</code> if the inheritable lock exists. This method is 2186 * primarily used by WebDAV. 2187 * 2188 * @param repositoryId the primary key for the repository 2189 * @param folderId the primary key for the folder 2190 * @param lockUuid the lock's UUID 2191 * @return <code>true</code> if the inheritable lock exists; 2192 <code>false</code> otherwise 2193 * @throws PortalException if the folder could not be found 2194 * @throws SystemException if a system exception occurred 2195 */ 2196 public boolean verifyInheritableLock(long repositoryId, long folderId, 2197 java.lang.String lockUuid) 2198 throws com.liferay.portal.kernel.exception.PortalException, 2199 com.liferay.portal.kernel.exception.SystemException; 2200 }