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