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