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