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