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 /** 750 * Returns a range of all the file entries and shortcuts in the folder. 751 * 752 * <p> 753 * Useful when paginating results. Returns a maximum of <code>end - 754 * start</code> instances. <code>start</code> and <code>end</code> are not 755 * primary keys, they are indexes in the result set. Thus, <code>0</code> 756 * refers to the first result in the set. Setting both <code>start</code> 757 * and <code>end</code> to {@link 758 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 759 * result set. 760 * </p> 761 * 762 * @param repositoryId the primary key of the repository 763 * @param folderId the primary key of the folder 764 * @param status the workflow status 765 * @param start the lower bound of the range of results 766 * @param end the upper bound of the range of results (not inclusive) 767 * @return the range of file entries and shortcuts in the folder 768 * @throws PortalException if the folder could not be found 769 * @throws SystemException if a system exception occurred 770 */ 771 @Override 772 public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts( 773 long repositoryId, long folderId, int status, int start, int end) 774 throws com.liferay.portal.kernel.exception.PortalException, 775 com.liferay.portal.kernel.exception.SystemException { 776 return _dlAppService.getFileEntriesAndFileShortcuts(repositoryId, 777 folderId, status, start, end); 778 } 779 780 /** 781 * Returns the number of file entries and shortcuts in the folder. 782 * 783 * @param repositoryId the primary key of the repository 784 * @param folderId the primary key of the folder 785 * @param status the workflow status 786 * @return the number of file entries and shortcuts in the folder 787 * @throws PortalException if the folder ould not be found 788 * @throws SystemException if a system exception occurred 789 */ 790 @Override 791 public int getFileEntriesAndFileShortcutsCount(long repositoryId, 792 long folderId, int status) 793 throws com.liferay.portal.kernel.exception.PortalException, 794 com.liferay.portal.kernel.exception.SystemException { 795 return _dlAppService.getFileEntriesAndFileShortcutsCount(repositoryId, 796 folderId, status); 797 } 798 799 /** 800 * Returns the number of file entries and shortcuts in the folder. 801 * 802 * @param repositoryId the primary key of the repository 803 * @param folderId the primary key of the folder 804 * @param status the workflow status 805 * @param mimeTypes allowed media types 806 * @return the number of file entries and shortcuts in the folder 807 * @throws PortalException if the folder ould not be found 808 * @throws SystemException if a system exception occurred 809 */ 810 @Override 811 public int getFileEntriesAndFileShortcutsCount(long repositoryId, 812 long folderId, int status, java.lang.String[] mimeTypes) 813 throws com.liferay.portal.kernel.exception.PortalException, 814 com.liferay.portal.kernel.exception.SystemException { 815 return _dlAppService.getFileEntriesAndFileShortcutsCount(repositoryId, 816 folderId, status, mimeTypes); 817 } 818 819 /** 820 * Returns the number of file entries in the folder. 821 * 822 * @param repositoryId the primary key of the file entry's repository 823 * @param folderId the primary key of the file entry's folder 824 * @return the number of file entries in the folder 825 * @throws PortalException if the folder could not be found 826 * @throws SystemException if a system exception occurred 827 */ 828 @Override 829 public int getFileEntriesCount(long repositoryId, long folderId) 830 throws com.liferay.portal.kernel.exception.PortalException, 831 com.liferay.portal.kernel.exception.SystemException { 832 return _dlAppService.getFileEntriesCount(repositoryId, folderId); 833 } 834 835 /** 836 * Returns the number of file entries with the file entry type in the 837 * folder. 838 * 839 * @param repositoryId the primary key of the file entry's repository 840 * @param folderId the primary key of the file entry's folder 841 * @param fileEntryTypeId the primary key of the file entry type 842 * @return the number of file entries with the file entry type in the folder 843 * @throws PortalException if the folder could not be found 844 * @throws SystemException if a system exception occurred 845 */ 846 @Override 847 public int getFileEntriesCount(long repositoryId, long folderId, 848 long fileEntryTypeId) 849 throws com.liferay.portal.kernel.exception.PortalException, 850 com.liferay.portal.kernel.exception.SystemException { 851 return _dlAppService.getFileEntriesCount(repositoryId, folderId, 852 fileEntryTypeId); 853 } 854 855 /** 856 * Returns the file entry with the primary key. 857 * 858 * @param fileEntryId the primary key of the file entry 859 * @return the file entry with the primary key 860 * @throws PortalException if the file entry could not be found 861 * @throws SystemException if a system exception occurred 862 */ 863 @Override 864 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 865 long fileEntryId) 866 throws com.liferay.portal.kernel.exception.PortalException, 867 com.liferay.portal.kernel.exception.SystemException { 868 return _dlAppService.getFileEntry(fileEntryId); 869 } 870 871 /** 872 * Returns the file entry with the title in the folder. 873 * 874 * @param groupId the primary key of the file entry's group 875 * @param folderId the primary key of the file entry's folder 876 * @param title the file entry's title 877 * @return the file entry with the title in the folder 878 * @throws PortalException if the file entry could not be found 879 * @throws SystemException if a system exception occurred 880 */ 881 @Override 882 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 883 long groupId, long folderId, java.lang.String title) 884 throws com.liferay.portal.kernel.exception.PortalException, 885 com.liferay.portal.kernel.exception.SystemException { 886 return _dlAppService.getFileEntry(groupId, folderId, title); 887 } 888 889 /** 890 * Returns the file entry with the UUID and group. 891 * 892 * @param uuid the file entry's UUID 893 * @param groupId the primary key of the file entry's group 894 * @return the file entry with the UUID and group 895 * @throws PortalException if the file entry could not be found 896 * @throws SystemException if a system exception occurred 897 */ 898 @Override 899 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId( 900 java.lang.String uuid, long groupId) 901 throws com.liferay.portal.kernel.exception.PortalException, 902 com.liferay.portal.kernel.exception.SystemException { 903 return _dlAppService.getFileEntryByUuidAndGroupId(uuid, groupId); 904 } 905 906 /** 907 * Returns the file shortcut with the primary key. This method is only 908 * supported by the Liferay repository. 909 * 910 * @param fileShortcutId the primary key of the file shortcut 911 * @return the file shortcut with the primary key 912 * @throws PortalException if the file shortcut could not be found 913 * @throws SystemException if a system exception occurred 914 */ 915 @Override 916 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 917 long fileShortcutId) 918 throws com.liferay.portal.kernel.exception.PortalException, 919 com.liferay.portal.kernel.exception.SystemException { 920 return _dlAppService.getFileShortcut(fileShortcutId); 921 } 922 923 /** 924 * Returns the folder with the primary key. 925 * 926 * @param folderId the primary key of the folder 927 * @return the folder with the primary key 928 * @throws PortalException if the folder could not be found 929 * @throws SystemException if a system exception occurred 930 */ 931 @Override 932 public com.liferay.portal.kernel.repository.model.Folder getFolder( 933 long folderId) 934 throws com.liferay.portal.kernel.exception.PortalException, 935 com.liferay.portal.kernel.exception.SystemException { 936 return _dlAppService.getFolder(folderId); 937 } 938 939 /** 940 * Returns the folder with the name in the parent folder. 941 * 942 * @param repositoryId the primary key of the folder's repository 943 * @param parentFolderId the primary key of the folder's parent folder 944 * @param name the folder's name 945 * @return the folder with the name in the parent folder 946 * @throws PortalException if the folder could not be found 947 * @throws SystemException if a system exception occurred 948 */ 949 @Override 950 public com.liferay.portal.kernel.repository.model.Folder getFolder( 951 long repositoryId, long parentFolderId, java.lang.String name) 952 throws com.liferay.portal.kernel.exception.PortalException, 953 com.liferay.portal.kernel.exception.SystemException { 954 return _dlAppService.getFolder(repositoryId, parentFolderId, name); 955 } 956 957 /** 958 * Returns all immediate subfolders of the parent folder. 959 * 960 * @param repositoryId the primary key of the folder's repository 961 * @param parentFolderId the primary key of the folder's parent folder 962 * @return the immediate subfolders of the parent folder 963 * @throws PortalException if the parent folder could not be found 964 * @throws SystemException if a system exception occurred 965 */ 966 @Override 967 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 968 long repositoryId, long parentFolderId) 969 throws com.liferay.portal.kernel.exception.PortalException, 970 com.liferay.portal.kernel.exception.SystemException { 971 return _dlAppService.getFolders(repositoryId, parentFolderId); 972 } 973 974 /** 975 * Returns all immediate subfolders of the parent folder, optionally 976 * including mount folders for third-party repositories. 977 * 978 * @param repositoryId the primary key of the folder's repository 979 * @param parentFolderId the primary key of the folder's parent folder 980 * @param includeMountFolders whether to include mount folders for 981 third-party repositories 982 * @return the immediate subfolders of the parent folder 983 * @throws PortalException if the parent folder could not be found 984 * @throws SystemException if a system exception occurred 985 */ 986 @Override 987 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 988 long repositoryId, long parentFolderId, boolean includeMountFolders) 989 throws com.liferay.portal.kernel.exception.PortalException, 990 com.liferay.portal.kernel.exception.SystemException { 991 return _dlAppService.getFolders(repositoryId, parentFolderId, 992 includeMountFolders); 993 } 994 995 /** 996 * Returns a range of all the immediate subfolders of the parent folder, 997 * optionally including mount folders for third-party repositories. 998 * 999 * <p> 1000 * Useful when paginating results. Returns a maximum of <code>end - 1001 * start</code> instances. <code>start</code> and <code>end</code> are not 1002 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1003 * refers to the first result in the set. Setting both <code>start</code> 1004 * and <code>end</code> to {@link 1005 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1006 * result set. 1007 * </p> 1008 * 1009 * @param repositoryId the primary key of the folder's repository 1010 * @param parentFolderId the primary key of the folder's parent folder 1011 * @param includeMountFolders whether to include mount folders for 1012 third-party repositories 1013 * @param start the lower bound of the range of results 1014 * @param end the upper bound of the range of results (not inclusive) 1015 * @return the range of immediate subfolders of the parent folder 1016 * @throws PortalException if the parent folder could not be found 1017 * @throws SystemException if a system exception occurred 1018 */ 1019 @Override 1020 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1021 long repositoryId, long parentFolderId, boolean includeMountFolders, 1022 int start, int end) 1023 throws com.liferay.portal.kernel.exception.PortalException, 1024 com.liferay.portal.kernel.exception.SystemException { 1025 return _dlAppService.getFolders(repositoryId, parentFolderId, 1026 includeMountFolders, start, end); 1027 } 1028 1029 /** 1030 * Returns an ordered range of all the immediate subfolders of the parent 1031 * folder. 1032 * 1033 * <p> 1034 * Useful when paginating results. Returns a maximum of <code>end - 1035 * start</code> instances. <code>start</code> and <code>end</code> are not 1036 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1037 * refers to the first result in the set. Setting both <code>start</code> 1038 * and <code>end</code> to {@link 1039 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1040 * result set. 1041 * </p> 1042 * 1043 * @param repositoryId the primary key of the folder's repository 1044 * @param parentFolderId the primary key of the folder's parent folder 1045 * @param includeMountFolders whether to include mount folders for 1046 third-party repositories 1047 * @param start the lower bound of the range of results 1048 * @param end the upper bound of the range of results (not inclusive) 1049 * @param obc the comparator to order the folders (optionally 1050 <code>null</code>) 1051 * @return the range of immediate subfolders of the parent folder ordered by 1052 comparator <code>obc</code> 1053 * @throws PortalException if the parent folder could not be found 1054 * @throws SystemException if a system exception occurred 1055 */ 1056 @Override 1057 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1058 long repositoryId, long parentFolderId, boolean includeMountFolders, 1059 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1060 throws com.liferay.portal.kernel.exception.PortalException, 1061 com.liferay.portal.kernel.exception.SystemException { 1062 return _dlAppService.getFolders(repositoryId, parentFolderId, 1063 includeMountFolders, start, end, obc); 1064 } 1065 1066 /** 1067 * Returns an ordered range of all the immediate subfolders of the parent 1068 * folder. 1069 * 1070 * <p> 1071 * Useful when paginating results. Returns a maximum of <code>end - 1072 * start</code> instances. <code>start</code> and <code>end</code> are not 1073 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1074 * refers to the first result in the set. Setting both <code>start</code> 1075 * and <code>end</code> to {@link 1076 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1077 * result set. 1078 * </p> 1079 * 1080 * @param repositoryId the primary key of the folder's repository 1081 * @param parentFolderId the primary key of the folder's parent folder 1082 * @param status the workflow status 1083 * @param includeMountFolders whether to include mount folders for 1084 third-party repositories 1085 * @param start the lower bound of the range of results 1086 * @param end the upper bound of the range of results (not inclusive) 1087 * @param obc the comparator to order the folders (optionally 1088 <code>null</code>) 1089 * @return the range of immediate subfolders of the parent folder ordered by 1090 comparator <code>obc</code> 1091 * @throws PortalException if the parent folder could not be found 1092 * @throws SystemException if a system exception occurred 1093 */ 1094 @Override 1095 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1096 long repositoryId, long parentFolderId, int status, 1097 boolean includeMountFolders, int start, int end, 1098 com.liferay.portal.kernel.util.OrderByComparator obc) 1099 throws com.liferay.portal.kernel.exception.PortalException, 1100 com.liferay.portal.kernel.exception.SystemException { 1101 return _dlAppService.getFolders(repositoryId, parentFolderId, status, 1102 includeMountFolders, start, end, obc); 1103 } 1104 1105 /** 1106 * Returns a range of all the immediate subfolders of the parent folder. 1107 * 1108 * <p> 1109 * Useful when paginating results. Returns a maximum of <code>end - 1110 * start</code> instances. <code>start</code> and <code>end</code> are not 1111 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1112 * refers to the first result in the set. Setting both <code>start</code> 1113 * and <code>end</code> to {@link 1114 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1115 * result set. 1116 * </p> 1117 * 1118 * @param repositoryId the primary key of the folder's repository 1119 * @param parentFolderId the primary key of the folder's parent folder 1120 * @param start the lower bound of the range of results 1121 * @param end the upper bound of the range of results (not inclusive) 1122 * @return the range of immediate subfolders of the parent folder 1123 * @throws PortalException if the parent folder could not be found 1124 * @throws SystemException if a system exception occurred 1125 */ 1126 @Override 1127 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1128 long repositoryId, long parentFolderId, int start, int end) 1129 throws com.liferay.portal.kernel.exception.PortalException, 1130 com.liferay.portal.kernel.exception.SystemException { 1131 return _dlAppService.getFolders(repositoryId, parentFolderId, start, end); 1132 } 1133 1134 /** 1135 * Returns an ordered range of all the immediate subfolders of the parent 1136 * folder. 1137 * 1138 * <p> 1139 * Useful when paginating results. Returns a maximum of <code>end - 1140 * start</code> instances. <code>start</code> and <code>end</code> are not 1141 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1142 * refers to the first result in the set. Setting both <code>start</code> 1143 * and <code>end</code> to {@link 1144 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1145 * result set. 1146 * </p> 1147 * 1148 * @param repositoryId the primary key of the folder's repository 1149 * @param parentFolderId the primary key of the folder's parent folder 1150 * @param start the lower bound of the range of results 1151 * @param end the upper bound of the range of results (not inclusive) 1152 * @param obc the comparator to order the folders (optionally 1153 <code>null</code>) 1154 * @return the range of immediate subfolders of the parent folder ordered by 1155 comparator <code>obc</code> 1156 * @throws PortalException if the parent folder could not be found 1157 * @throws SystemException if a system exception occurred 1158 */ 1159 @Override 1160 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1161 long repositoryId, long parentFolderId, int start, int end, 1162 com.liferay.portal.kernel.util.OrderByComparator obc) 1163 throws com.liferay.portal.kernel.exception.PortalException, 1164 com.liferay.portal.kernel.exception.SystemException { 1165 return _dlAppService.getFolders(repositoryId, parentFolderId, start, 1166 end, obc); 1167 } 1168 1169 /** 1170 * Returns a range of all the immediate subfolders, file entries, and file 1171 * shortcuts in the parent folder. 1172 * 1173 * <p> 1174 * Useful when paginating results. Returns a maximum of <code>end - 1175 * start</code> instances. <code>start</code> and <code>end</code> are not 1176 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1177 * refers to the first result in the set. Setting both <code>start</code> 1178 * and <code>end</code> to {@link 1179 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1180 * result set. 1181 * </p> 1182 * 1183 * @param repositoryId the primary key of the repository 1184 * @param folderId the primary key of the parent folder 1185 * @param status the workflow status 1186 * @param includeMountFolders whether to include mount folders for 1187 third-party repositories 1188 * @param start the lower bound of the range of results 1189 * @param end the upper bound of the range of results (not inclusive) 1190 * @return the range of immediate subfolders, file entries, and file 1191 shortcuts in the parent folder ordered by comparator 1192 <code>obc</code> 1193 * @throws PortalException if the parent folder could not be found 1194 * @throws SystemException if a system exception occurred 1195 */ 1196 @Override 1197 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1198 long repositoryId, long folderId, int status, 1199 boolean includeMountFolders, int start, int end) 1200 throws com.liferay.portal.kernel.exception.PortalException, 1201 com.liferay.portal.kernel.exception.SystemException { 1202 return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId, 1203 folderId, status, includeMountFolders, start, end); 1204 } 1205 1206 /** 1207 * Returns an ordered range of all the immediate subfolders, file entries, 1208 * and file shortcuts in the parent folder. 1209 * 1210 * <p> 1211 * Useful when paginating results. Returns a maximum of <code>end - 1212 * start</code> instances. <code>start</code> and <code>end</code> are not 1213 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1214 * refers to the first result in the set. Setting both <code>start</code> 1215 * and <code>end</code> to {@link 1216 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1217 * result set. 1218 * </p> 1219 * 1220 * @param repositoryId the primary key of the repository 1221 * @param folderId the primary key of the parent folder 1222 * @param status the workflow status 1223 * @param includeMountFolders whether to include mount folders for 1224 third-party repositories 1225 * @param start the lower bound of the range of results 1226 * @param end the upper bound of the range of results (not inclusive) 1227 * @param obc the comparator to order the results (optionally 1228 <code>null</code>) 1229 * @return the range of immediate subfolders, file entries, and file 1230 shortcuts in the parent folder ordered by comparator 1231 <code>obc</code> 1232 * @throws PortalException if the parent folder could not be found 1233 * @throws SystemException if a system exception occurred 1234 */ 1235 @Override 1236 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1237 long repositoryId, long folderId, int status, 1238 boolean includeMountFolders, int start, int end, 1239 com.liferay.portal.kernel.util.OrderByComparator obc) 1240 throws com.liferay.portal.kernel.exception.PortalException, 1241 com.liferay.portal.kernel.exception.SystemException { 1242 return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId, 1243 folderId, status, includeMountFolders, start, end, obc); 1244 } 1245 1246 @Override 1247 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1248 long repositoryId, long folderId, int status, 1249 java.lang.String[] mimeTypes, boolean includeMountFolders, int start, 1250 int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1251 throws com.liferay.portal.kernel.exception.PortalException, 1252 com.liferay.portal.kernel.exception.SystemException { 1253 return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId, 1254 folderId, status, mimeTypes, includeMountFolders, start, end, obc); 1255 } 1256 1257 /** 1258 * Returns the number of immediate subfolders, file entries, and file 1259 * shortcuts in the parent folder. 1260 * 1261 * @param repositoryId the primary key of the repository 1262 * @param folderId the primary key of the parent folder 1263 * @param status the workflow status 1264 * @param includeMountFolders whether to include mount folders for 1265 third-party repositories 1266 * @return the number of immediate subfolders, file entries, and file 1267 shortcuts in the parent folder 1268 * @throws PortalException if the folder could not be found 1269 * @throws SystemException if a system exception occurred 1270 */ 1271 @Override 1272 public int getFoldersAndFileEntriesAndFileShortcutsCount( 1273 long repositoryId, long folderId, int status, 1274 boolean includeMountFolders) 1275 throws com.liferay.portal.kernel.exception.PortalException, 1276 com.liferay.portal.kernel.exception.SystemException { 1277 return _dlAppService.getFoldersAndFileEntriesAndFileShortcutsCount(repositoryId, 1278 folderId, status, includeMountFolders); 1279 } 1280 1281 @Override 1282 public int getFoldersAndFileEntriesAndFileShortcutsCount( 1283 long repositoryId, long folderId, int status, 1284 java.lang.String[] mimeTypes, boolean includeMountFolders) 1285 throws com.liferay.portal.kernel.exception.PortalException, 1286 com.liferay.portal.kernel.exception.SystemException { 1287 return _dlAppService.getFoldersAndFileEntriesAndFileShortcutsCount(repositoryId, 1288 folderId, status, mimeTypes, includeMountFolders); 1289 } 1290 1291 /** 1292 * Returns the number of immediate subfolders of the parent folder. 1293 * 1294 * @param repositoryId the primary key of the folder's repository 1295 * @param parentFolderId the primary key of the folder's parent folder 1296 * @return the number of immediate subfolders of the parent folder 1297 * @throws PortalException if the parent folder could not be found 1298 * @throws SystemException if a system exception occurred 1299 */ 1300 @Override 1301 public int getFoldersCount(long repositoryId, long parentFolderId) 1302 throws com.liferay.portal.kernel.exception.PortalException, 1303 com.liferay.portal.kernel.exception.SystemException { 1304 return _dlAppService.getFoldersCount(repositoryId, parentFolderId); 1305 } 1306 1307 /** 1308 * Returns the number of immediate subfolders of the parent folder, 1309 * optionally including mount folders for third-party repositories. 1310 * 1311 * @param repositoryId the primary key of the folder's repository 1312 * @param parentFolderId the primary key of the folder's parent folder 1313 * @param includeMountFolders whether to include mount folders for 1314 third-party repositories 1315 * @return the number of immediate subfolders of the parent folder 1316 * @throws PortalException if the parent folder could not be found 1317 * @throws SystemException if a system exception occurred 1318 */ 1319 @Override 1320 public int getFoldersCount(long repositoryId, long parentFolderId, 1321 boolean includeMountFolders) 1322 throws com.liferay.portal.kernel.exception.PortalException, 1323 com.liferay.portal.kernel.exception.SystemException { 1324 return _dlAppService.getFoldersCount(repositoryId, parentFolderId, 1325 includeMountFolders); 1326 } 1327 1328 /** 1329 * Returns the number of immediate subfolders of the parent folder, 1330 * optionally including mount folders for third-party repositories. 1331 * 1332 * @param repositoryId the primary key of the folder's repository 1333 * @param parentFolderId the primary key of the folder's parent folder 1334 * @param status the workflow status 1335 * @param includeMountFolders whether to include mount folders for 1336 third-party repositories 1337 * @return the number of immediate subfolders of the parent folder 1338 * @throws PortalException if the parent folder could not be found 1339 * @throws SystemException if a system exception occurred 1340 */ 1341 @Override 1342 public int getFoldersCount(long repositoryId, long parentFolderId, 1343 int status, boolean includeMountFolders) 1344 throws com.liferay.portal.kernel.exception.PortalException, 1345 com.liferay.portal.kernel.exception.SystemException { 1346 return _dlAppService.getFoldersCount(repositoryId, parentFolderId, 1347 status, includeMountFolders); 1348 } 1349 1350 /** 1351 * Returns the number of immediate subfolders and file entries across the 1352 * folders. 1353 * 1354 * @param repositoryId the primary key of the repository 1355 * @param folderIds the primary keys of folders from which to count 1356 immediate subfolders and file entries 1357 * @param status the workflow status 1358 * @return the number of immediate subfolders and file entries across the 1359 folders 1360 * @throws PortalException if the repository could not be found 1361 * @throws SystemException if a system exception occurred 1362 */ 1363 @Override 1364 public int getFoldersFileEntriesCount(long repositoryId, 1365 java.util.List<java.lang.Long> folderIds, int status) 1366 throws com.liferay.portal.kernel.exception.PortalException, 1367 com.liferay.portal.kernel.exception.SystemException { 1368 return _dlAppService.getFoldersFileEntriesCount(repositoryId, 1369 folderIds, status); 1370 } 1371 1372 /** 1373 * Returns an ordered range of all the file entries in the group starting at 1374 * the repository default parent folder that are stored within the Liferay 1375 * repository. This method is primarily used to search for recently modified 1376 * file entries. It can be limited to the file entries modified by a given 1377 * user. 1378 * 1379 * <p> 1380 * Useful when paginating results. Returns a maximum of <code>end - 1381 * start</code> instances. <code>start</code> and <code>end</code> are not 1382 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1383 * refers to the first result in the set. Setting both <code>start</code> 1384 * and <code>end</code> to {@link 1385 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1386 * result set. 1387 * </p> 1388 * 1389 * @param groupId the primary key of the group 1390 * @param userId the primary key of the user who created the file 1391 (optionally <code>0</code>) 1392 * @param start the lower bound of the range of results 1393 * @param end the upper bound of the range of results (not inclusive) 1394 * @return the range of matching file entries ordered by date modified 1395 * @throws PortalException if the group could not be found 1396 * @throws SystemException if a system exception occurred 1397 */ 1398 @Override 1399 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1400 long groupId, long userId, int start, int end) 1401 throws com.liferay.portal.kernel.exception.PortalException, 1402 com.liferay.portal.kernel.exception.SystemException { 1403 return _dlAppService.getGroupFileEntries(groupId, userId, start, end); 1404 } 1405 1406 /** 1407 * Returns an ordered range of all the file entries in the group that are 1408 * stored within the Liferay repository. This method is primarily used to 1409 * search for recently modified file entries. It can be limited to the file 1410 * entries modified by a given user. 1411 * 1412 * <p> 1413 * Useful when paginating results. Returns a maximum of <code>end - 1414 * start</code> instances. <code>start</code> and <code>end</code> are not 1415 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1416 * refers to the first result in the set. Setting both <code>start</code> 1417 * and <code>end</code> to {@link 1418 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1419 * result set. 1420 * </p> 1421 * 1422 * @param groupId the primary key of the group 1423 * @param userId the primary key of the user who created the file 1424 (optionally <code>0</code>) 1425 * @param start the lower bound of the range of results 1426 * @param end the upper bound of the range of results (not inclusive) 1427 * @param obc the comparator to order the file entries (optionally 1428 <code>null</code>) 1429 * @return the range of matching file entries ordered by comparator 1430 <code>obc</code> 1431 * @throws PortalException if the group could not be found 1432 * @throws SystemException if a system exception occurred 1433 */ 1434 @Override 1435 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1436 long groupId, long userId, int start, int end, 1437 com.liferay.portal.kernel.util.OrderByComparator obc) 1438 throws com.liferay.portal.kernel.exception.PortalException, 1439 com.liferay.portal.kernel.exception.SystemException { 1440 return _dlAppService.getGroupFileEntries(groupId, userId, start, end, 1441 obc); 1442 } 1443 1444 /** 1445 * Returns an ordered range of all the file entries in the group starting at 1446 * the root folder that are stored within the Liferay repository. This 1447 * method is primarily used to search for recently modified file entries. It 1448 * can be limited to the file entries modified by a given user. 1449 * 1450 * <p> 1451 * Useful when paginating results. Returns a maximum of <code>end - 1452 * start</code> instances. <code>start</code> and <code>end</code> are not 1453 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1454 * refers to the first result in the set. Setting both <code>start</code> 1455 * and <code>end</code> to {@link 1456 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1457 * result set. 1458 * </p> 1459 * 1460 * @param groupId the primary key of the group 1461 * @param userId the primary key of the user who created the file 1462 (optionally <code>0</code>) 1463 * @param rootFolderId the primary key of the root folder to begin the 1464 search 1465 * @param start the lower bound of the range of results 1466 * @param end the upper bound of the range of results (not inclusive) 1467 * @return the range of matching file entries ordered by date modified 1468 * @throws PortalException if the group could not be found 1469 * @throws SystemException if a system exception occurred 1470 */ 1471 @Override 1472 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1473 long groupId, long userId, long rootFolderId, int start, int end) 1474 throws com.liferay.portal.kernel.exception.PortalException, 1475 com.liferay.portal.kernel.exception.SystemException { 1476 return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId, 1477 start, end); 1478 } 1479 1480 /** 1481 * Returns an ordered range of all the file entries in the group starting at 1482 * the root folder that are stored within the Liferay repository. This 1483 * method is primarily used to search for recently modified file entries. It 1484 * can be limited to the file entries modified by a given user. 1485 * 1486 * <p> 1487 * Useful when paginating results. Returns a maximum of <code>end - 1488 * start</code> instances. <code>start</code> and <code>end</code> are not 1489 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1490 * refers to the first result in the set. Setting both <code>start</code> 1491 * and <code>end</code> to {@link 1492 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1493 * result set. 1494 * </p> 1495 * 1496 * @param groupId the primary key of the group 1497 * @param userId the primary key of the user who created the file 1498 (optionally <code>0</code>) 1499 * @param rootFolderId the primary key of the root folder to begin the 1500 search 1501 * @param start the lower bound of the range of results 1502 * @param end the upper bound of the range of results (not inclusive) 1503 * @param obc the comparator to order the file entries (optionally 1504 <code>null</code>) 1505 * @return the range of matching file entries ordered by comparator 1506 <code>obc</code> 1507 * @throws PortalException if the group could not be found 1508 * @throws SystemException if a system exception occurred 1509 */ 1510 @Override 1511 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1512 long groupId, long userId, long rootFolderId, int start, int end, 1513 com.liferay.portal.kernel.util.OrderByComparator obc) 1514 throws com.liferay.portal.kernel.exception.PortalException, 1515 com.liferay.portal.kernel.exception.SystemException { 1516 return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId, 1517 start, end, obc); 1518 } 1519 1520 @Override 1521 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1522 long groupId, long userId, long rootFolderId, 1523 java.lang.String[] mimeTypes, int status, int start, int end, 1524 com.liferay.portal.kernel.util.OrderByComparator obc) 1525 throws com.liferay.portal.kernel.exception.PortalException, 1526 com.liferay.portal.kernel.exception.SystemException { 1527 return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId, 1528 mimeTypes, status, start, end, obc); 1529 } 1530 1531 /** 1532 * Returns the number of file entries in a group starting at the repository 1533 * default parent folder that are stored within the Liferay repository. This 1534 * method is primarily used to search for recently modified file entries. It 1535 * can be limited to the file entries modified by a given user. 1536 * 1537 * @param groupId the primary key of the group 1538 * @param userId the primary key of the user who created the file 1539 (optionally <code>0</code>) 1540 * @return the number of matching file entries 1541 * @throws PortalException if the group could not be found 1542 * @throws SystemException if a system exception occurred 1543 */ 1544 @Override 1545 public int getGroupFileEntriesCount(long groupId, long userId) 1546 throws com.liferay.portal.kernel.exception.PortalException, 1547 com.liferay.portal.kernel.exception.SystemException { 1548 return _dlAppService.getGroupFileEntriesCount(groupId, userId); 1549 } 1550 1551 /** 1552 * Returns the number of file entries in a group starting at the root folder 1553 * that are stored within the Liferay repository. This method is primarily 1554 * used to search for recently modified file entries. It can be limited to 1555 * the file entries modified by a given user. 1556 * 1557 * @param groupId the primary key of the group 1558 * @param userId the primary key of the user who created the file 1559 (optionally <code>0</code>) 1560 * @param rootFolderId the primary key of the root folder to begin the 1561 search 1562 * @return the number of matching file entries 1563 * @throws PortalException if the group could not be found 1564 * @throws SystemException if a system exception occurred 1565 */ 1566 @Override 1567 public int getGroupFileEntriesCount(long groupId, long userId, 1568 long rootFolderId) 1569 throws com.liferay.portal.kernel.exception.PortalException, 1570 com.liferay.portal.kernel.exception.SystemException { 1571 return _dlAppService.getGroupFileEntriesCount(groupId, userId, 1572 rootFolderId); 1573 } 1574 1575 @Override 1576 public int getGroupFileEntriesCount(long groupId, long userId, 1577 long rootFolderId, java.lang.String[] mimeTypes, int status) 1578 throws com.liferay.portal.kernel.exception.PortalException, 1579 com.liferay.portal.kernel.exception.SystemException { 1580 return _dlAppService.getGroupFileEntriesCount(groupId, userId, 1581 rootFolderId, mimeTypes, status); 1582 } 1583 1584 /** 1585 * Returns all immediate subfolders of the parent folder that are used for 1586 * mounting third-party repositories. This method is only supported by the 1587 * Liferay repository. 1588 * 1589 * @param repositoryId the primary key of the folder's repository 1590 * @param parentFolderId the primary key of the folder's parent folder 1591 * @return the immediate subfolders of the parent folder that are used for 1592 mounting third-party repositories 1593 * @throws PortalException if the repository or parent folder could not be 1594 found 1595 * @throws SystemException if a system exception occurred 1596 */ 1597 @Override 1598 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1599 long repositoryId, long parentFolderId) 1600 throws com.liferay.portal.kernel.exception.PortalException, 1601 com.liferay.portal.kernel.exception.SystemException { 1602 return _dlAppService.getMountFolders(repositoryId, parentFolderId); 1603 } 1604 1605 /** 1606 * Returns a range of all the immediate subfolders of the parent folder that 1607 * are used for mounting third-party repositories. This method is only 1608 * supported by the Liferay repository. 1609 * 1610 * <p> 1611 * Useful when paginating results. Returns a maximum of <code>end - 1612 * start</code> instances. <code>start</code> and <code>end</code> are not 1613 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1614 * refers to the first result in the set. Setting both <code>start</code> 1615 * and <code>end</code> to {@link 1616 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1617 * result set. 1618 * </p> 1619 * 1620 * @param repositoryId the primary key of the repository 1621 * @param parentFolderId the primary key of the parent folder 1622 * @param start the lower bound of the range of results 1623 * @param end the upper bound of the range of results (not inclusive) 1624 * @return the range of immediate subfolders of the parent folder that are 1625 used for mounting third-party repositories 1626 * @throws PortalException if the repository or parent folder could not be 1627 found 1628 * @throws SystemException if a system exception occurred 1629 */ 1630 @Override 1631 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1632 long repositoryId, long parentFolderId, int start, int end) 1633 throws com.liferay.portal.kernel.exception.PortalException, 1634 com.liferay.portal.kernel.exception.SystemException { 1635 return _dlAppService.getMountFolders(repositoryId, parentFolderId, 1636 start, end); 1637 } 1638 1639 /** 1640 * Returns an ordered range of all the immediate subfolders of the parent 1641 * folder that are used for mounting third-party repositories. This method 1642 * is only supported by the Liferay repository. 1643 * 1644 * <p> 1645 * Useful when paginating results. Returns a maximum of <code>end - 1646 * start</code> instances. <code>start</code> and <code>end</code> are not 1647 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1648 * refers to the first result in the set. Setting both <code>start</code> 1649 * and <code>end</code> to {@link 1650 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1651 * result set. 1652 * </p> 1653 * 1654 * @param repositoryId the primary key of the folder's repository 1655 * @param parentFolderId the primary key of the folder's parent folder 1656 * @param start the lower bound of the range of results 1657 * @param end the upper bound of the range of results (not inclusive) 1658 * @param obc the comparator to order the folders (optionally 1659 <code>null</code>) 1660 * @return the range of immediate subfolders of the parent folder that are 1661 used for mounting third-party repositories ordered by comparator 1662 <code>obc</code> 1663 * @throws PortalException if the repository or parent folder could not be 1664 found 1665 * @throws SystemException if a system exception occurred 1666 */ 1667 @Override 1668 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1669 long repositoryId, long parentFolderId, int start, int end, 1670 com.liferay.portal.kernel.util.OrderByComparator obc) 1671 throws com.liferay.portal.kernel.exception.PortalException, 1672 com.liferay.portal.kernel.exception.SystemException { 1673 return _dlAppService.getMountFolders(repositoryId, parentFolderId, 1674 start, end, obc); 1675 } 1676 1677 /** 1678 * Returns the number of immediate subfolders of the parent folder that are 1679 * used for mounting third-party repositories. This method is only supported 1680 * by the Liferay repository. 1681 * 1682 * @param repositoryId the primary key of the repository 1683 * @param parentFolderId the primary key of the parent folder 1684 * @return the number of folders of the parent folder that are used for 1685 mounting third-party repositories 1686 * @throws PortalException if the repository or parent folder could not be 1687 found 1688 * @throws SystemException if a system exception occurred 1689 */ 1690 @Override 1691 public int getMountFoldersCount(long repositoryId, long parentFolderId) 1692 throws com.liferay.portal.kernel.exception.PortalException, 1693 com.liferay.portal.kernel.exception.SystemException { 1694 return _dlAppService.getMountFoldersCount(repositoryId, parentFolderId); 1695 } 1696 1697 @Override 1698 public void getSubfolderIds(long repositoryId, 1699 java.util.List<java.lang.Long> folderIds, long folderId) 1700 throws com.liferay.portal.kernel.exception.PortalException, 1701 com.liferay.portal.kernel.exception.SystemException { 1702 _dlAppService.getSubfolderIds(repositoryId, folderIds, folderId); 1703 } 1704 1705 /** 1706 * Returns all the descendant folders of the folder with the primary key. 1707 * 1708 * @param repositoryId the primary key of the repository 1709 * @param folderId the primary key of the folder 1710 * @return the descendant folders of the folder with the primary key 1711 * @throws PortalException if the repository or parent folder could not be 1712 found 1713 * @throws SystemException if a system exception occurred 1714 */ 1715 @Override 1716 public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId, 1717 long folderId) 1718 throws com.liferay.portal.kernel.exception.PortalException, 1719 com.liferay.portal.kernel.exception.SystemException { 1720 return _dlAppService.getSubfolderIds(repositoryId, folderId); 1721 } 1722 1723 /** 1724 * Returns descendant folders of the folder with the primary key, optionally 1725 * limiting to one level deep. 1726 * 1727 * @param repositoryId the primary key of the repository 1728 * @param folderId the primary key of the folder 1729 * @param recurse whether to recurse through each subfolder 1730 * @return the descendant folders of the folder with the primary key 1731 * @throws PortalException if the repository or parent folder could not be 1732 found 1733 * @throws SystemException if a system exception occurred 1734 */ 1735 @Override 1736 public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId, 1737 long folderId, boolean recurse) 1738 throws com.liferay.portal.kernel.exception.PortalException, 1739 com.liferay.portal.kernel.exception.SystemException { 1740 return _dlAppService.getSubfolderIds(repositoryId, folderId, recurse); 1741 } 1742 1743 /** 1744 * Returns all the temporary file entry names. 1745 * 1746 * @param groupId the primary key of the group 1747 * @param folderId the primary key of the folder where the file entry will 1748 eventually reside 1749 * @param tempFolderName the temporary folder's name 1750 * @return the temporary file entry names 1751 * @throws PortalException if the folder was invalid 1752 * @throws SystemException if a system exception occurred 1753 * @see #addTempFileEntry(long, long, String, String, File, String) 1754 * @see com.liferay.portal.kernel.util.TempFileUtil 1755 */ 1756 @Override 1757 public java.lang.String[] getTempFileEntryNames(long groupId, 1758 long folderId, java.lang.String tempFolderName) 1759 throws com.liferay.portal.kernel.exception.PortalException, 1760 com.liferay.portal.kernel.exception.SystemException { 1761 return _dlAppService.getTempFileEntryNames(groupId, folderId, 1762 tempFolderName); 1763 } 1764 1765 /** 1766 * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long, 1767 ServiceContext)} 1768 */ 1769 @Override 1770 public com.liferay.portal.model.Lock lockFileEntry(long fileEntryId) 1771 throws com.liferay.portal.kernel.exception.PortalException, 1772 com.liferay.portal.kernel.exception.SystemException { 1773 return _dlAppService.lockFileEntry(fileEntryId); 1774 } 1775 1776 /** 1777 * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long, 1778 String, long, ServiceContext)} 1779 */ 1780 @Override 1781 public com.liferay.portal.model.Lock lockFileEntry(long fileEntryId, 1782 java.lang.String owner, long expirationTime) 1783 throws com.liferay.portal.kernel.exception.PortalException, 1784 com.liferay.portal.kernel.exception.SystemException { 1785 return _dlAppService.lockFileEntry(fileEntryId, owner, expirationTime); 1786 } 1787 1788 /** 1789 * Locks the folder. This method is primarily used by WebDAV. 1790 * 1791 * @param repositoryId the primary key of the repository 1792 * @param folderId the primary key of the folder 1793 * @return the lock object 1794 * @throws PortalException if the repository or folder could not be found 1795 * @throws SystemException if a system exception occurred 1796 */ 1797 @Override 1798 public com.liferay.portal.model.Lock lockFolder(long repositoryId, 1799 long folderId) 1800 throws com.liferay.portal.kernel.exception.PortalException, 1801 com.liferay.portal.kernel.exception.SystemException { 1802 return _dlAppService.lockFolder(repositoryId, folderId); 1803 } 1804 1805 /** 1806 * Locks the folder. This method is primarily used by WebDAV. 1807 * 1808 * @param repositoryId the primary key of the repository 1809 * @param folderId the primary key of the folder 1810 * @param owner the owner string for the checkout (optionally 1811 <code>null</code>) 1812 * @param inheritable whether the lock must propagate to descendants 1813 * @param expirationTime the time in milliseconds before the lock expires. 1814 If the value is <code>0</code>, the default expiration time will 1815 be used from <code>portal.properties>. 1816 * @return the lock object 1817 * @throws PortalException if the repository or folder could not be found 1818 * @throws SystemException if a system exception occurred 1819 */ 1820 @Override 1821 public com.liferay.portal.model.Lock lockFolder(long repositoryId, 1822 long folderId, java.lang.String owner, boolean inheritable, 1823 long expirationTime) 1824 throws com.liferay.portal.kernel.exception.PortalException, 1825 com.liferay.portal.kernel.exception.SystemException { 1826 return _dlAppService.lockFolder(repositoryId, folderId, owner, 1827 inheritable, expirationTime); 1828 } 1829 1830 /** 1831 * Moves the file entry to the new folder. 1832 * 1833 * @param fileEntryId the primary key of the file entry 1834 * @param newFolderId the primary key of the new folder 1835 * @param serviceContext the service context to be applied 1836 * @return the file entry 1837 * @throws PortalException if the file entry or the new folder could not be 1838 found 1839 * @throws SystemException if a system exception occurred 1840 */ 1841 @Override 1842 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry( 1843 long fileEntryId, long newFolderId, 1844 com.liferay.portal.service.ServiceContext serviceContext) 1845 throws com.liferay.portal.kernel.exception.PortalException, 1846 com.liferay.portal.kernel.exception.SystemException { 1847 return _dlAppService.moveFileEntry(fileEntryId, newFolderId, 1848 serviceContext); 1849 } 1850 1851 /** 1852 * Moves the file entry from a trashed folder to the new folder. 1853 * 1854 * @param fileEntryId the primary key of the file entry 1855 * @param newFolderId the primary key of the new folder 1856 * @param serviceContext the service context to be applied 1857 * @return the file entry 1858 * @throws PortalException if the file entry or the new folder could not be 1859 found 1860 * @throws SystemException if a system exception occurred 1861 */ 1862 @Override 1863 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryFromTrash( 1864 long fileEntryId, long newFolderId, 1865 com.liferay.portal.service.ServiceContext serviceContext) 1866 throws com.liferay.portal.kernel.exception.PortalException, 1867 com.liferay.portal.kernel.exception.SystemException { 1868 return _dlAppService.moveFileEntryFromTrash(fileEntryId, newFolderId, 1869 serviceContext); 1870 } 1871 1872 /** 1873 * Moves the file entry with the primary key to the trash portlet. 1874 * 1875 * @param fileEntryId the primary key of the file entry 1876 * @return the file entry 1877 * @throws PortalException if the file entry could not be found 1878 * @throws SystemException if a system exception occurred 1879 */ 1880 @Override 1881 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash( 1882 long fileEntryId) 1883 throws com.liferay.portal.kernel.exception.PortalException, 1884 com.liferay.portal.kernel.exception.SystemException { 1885 return _dlAppService.moveFileEntryToTrash(fileEntryId); 1886 } 1887 1888 /** 1889 * Moves the file shortcut from a trashed folder to the new folder. 1890 * 1891 * @param fileShortcutId the primary key of the file shortcut 1892 * @param newFolderId the primary key of the new folder 1893 * @param serviceContext the service context to be applied 1894 * @return the file shortcut 1895 * @throws PortalException if the file entry or the new folder could not be 1896 found 1897 * @throws SystemException if a system exception occurred 1898 */ 1899 @Override 1900 public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutFromTrash( 1901 long fileShortcutId, long newFolderId, 1902 com.liferay.portal.service.ServiceContext serviceContext) 1903 throws com.liferay.portal.kernel.exception.PortalException, 1904 com.liferay.portal.kernel.exception.SystemException { 1905 return _dlAppService.moveFileShortcutFromTrash(fileShortcutId, 1906 newFolderId, serviceContext); 1907 } 1908 1909 /** 1910 * Moves the file shortcut with the primary key to the trash portlet. 1911 * 1912 * @param fileShortcutId the primary key of the file shortcut 1913 * @return the file shortcut 1914 * @throws PortalException if the file shortcut could not be found 1915 * @throws SystemException if a system exception occurred 1916 */ 1917 @Override 1918 public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutToTrash( 1919 long fileShortcutId) 1920 throws com.liferay.portal.kernel.exception.PortalException, 1921 com.liferay.portal.kernel.exception.SystemException { 1922 return _dlAppService.moveFileShortcutToTrash(fileShortcutId); 1923 } 1924 1925 /** 1926 * Moves the folder to the new parent folder with the primary key. 1927 * 1928 * @param folderId the primary key of the folder 1929 * @param parentFolderId the primary key of the new parent folder 1930 * @param serviceContext the service context to be applied 1931 * @return the file entry 1932 * @throws PortalException if the folder could not be found 1933 * @throws SystemException if a system exception occurred 1934 */ 1935 @Override 1936 public com.liferay.portal.kernel.repository.model.Folder moveFolder( 1937 long folderId, long parentFolderId, 1938 com.liferay.portal.service.ServiceContext serviceContext) 1939 throws com.liferay.portal.kernel.exception.PortalException, 1940 com.liferay.portal.kernel.exception.SystemException { 1941 return _dlAppService.moveFolder(folderId, parentFolderId, serviceContext); 1942 } 1943 1944 /** 1945 * Moves the folder with the primary key from the trash portlet to the new 1946 * parent folder with the primary key. 1947 * 1948 * @param folderId the primary key of the folder 1949 * @param parentFolderId the primary key of the new parent folder 1950 * @param serviceContext the service context to be applied 1951 * @return the file entry 1952 * @throws PortalException if the folder could not be found 1953 * @throws SystemException if a system exception occurred 1954 */ 1955 @Override 1956 public com.liferay.portal.kernel.repository.model.Folder moveFolderFromTrash( 1957 long folderId, long parentFolderId, 1958 com.liferay.portal.service.ServiceContext serviceContext) 1959 throws com.liferay.portal.kernel.exception.PortalException, 1960 com.liferay.portal.kernel.exception.SystemException { 1961 return _dlAppService.moveFolderFromTrash(folderId, parentFolderId, 1962 serviceContext); 1963 } 1964 1965 /** 1966 * Moves the folder with the primary key to the trash portlet. 1967 * 1968 * @param folderId the primary key of the folder 1969 * @return the file entry 1970 * @throws PortalException if the folder could not be found 1971 * @throws SystemException if a system exception occurred 1972 */ 1973 @Override 1974 public com.liferay.portal.kernel.repository.model.Folder moveFolderToTrash( 1975 long folderId) 1976 throws com.liferay.portal.kernel.exception.PortalException, 1977 com.liferay.portal.kernel.exception.SystemException { 1978 return _dlAppService.moveFolderToTrash(folderId); 1979 } 1980 1981 /** 1982 * Refreshes the lock for the file entry. This method is primarily used by 1983 * WebDAV. 1984 * 1985 * @param lockUuid the lock's UUID 1986 * @param companyId the primary key of the file entry's company 1987 * @param expirationTime the time in milliseconds before the lock expires. 1988 If the value is <code>0</code>, the default expiration time will 1989 be used from <code>portal.properties>. 1990 * @return the lock object 1991 * @throws PortalException if the file entry or lock could not be found 1992 * @throws SystemException if a system exception occurred 1993 */ 1994 @Override 1995 public com.liferay.portal.model.Lock refreshFileEntryLock( 1996 java.lang.String lockUuid, long companyId, long expirationTime) 1997 throws com.liferay.portal.kernel.exception.PortalException, 1998 com.liferay.portal.kernel.exception.SystemException { 1999 return _dlAppService.refreshFileEntryLock(lockUuid, companyId, 2000 expirationTime); 2001 } 2002 2003 /** 2004 * Refreshes the lock for the folder. This method is primarily used by 2005 * WebDAV. 2006 * 2007 * @param lockUuid the lock's UUID 2008 * @param companyId the primary key of the file entry's company 2009 * @param expirationTime the time in milliseconds before the lock expires. 2010 If the value is <code>0</code>, the default expiration time will 2011 be used from <code>portal.properties>. 2012 * @return the lock object 2013 * @throws PortalException if the folder or lock could not be found 2014 * @throws SystemException if a system exception occurred 2015 */ 2016 @Override 2017 public com.liferay.portal.model.Lock refreshFolderLock( 2018 java.lang.String lockUuid, long companyId, long expirationTime) 2019 throws com.liferay.portal.kernel.exception.PortalException, 2020 com.liferay.portal.kernel.exception.SystemException { 2021 return _dlAppService.refreshFolderLock(lockUuid, companyId, 2022 expirationTime); 2023 } 2024 2025 /** 2026 * Restores the file entry with the primary key from the trash portlet. 2027 * 2028 * @param fileEntryId the primary key of the file entry 2029 * @throws PortalException if the file entry could not be found 2030 * @throws SystemException if a system exception occurred 2031 */ 2032 @Override 2033 public void restoreFileEntryFromTrash(long fileEntryId) 2034 throws com.liferay.portal.kernel.exception.PortalException, 2035 com.liferay.portal.kernel.exception.SystemException { 2036 _dlAppService.restoreFileEntryFromTrash(fileEntryId); 2037 } 2038 2039 /** 2040 * Restores the file shortcut with the primary key from the trash portlet. 2041 * 2042 * @param fileShortcutId the primary key of the file shortcut 2043 * @throws PortalException if the file shortcut could not be found 2044 * @throws SystemException if a system exception occurred 2045 */ 2046 @Override 2047 public void restoreFileShortcutFromTrash(long fileShortcutId) 2048 throws com.liferay.portal.kernel.exception.PortalException, 2049 com.liferay.portal.kernel.exception.SystemException { 2050 _dlAppService.restoreFileShortcutFromTrash(fileShortcutId); 2051 } 2052 2053 /** 2054 * Restores the folder with the primary key from the trash portlet. 2055 * 2056 * @param folderId the primary key of the folder 2057 * @throws PortalException if the folder could not be found 2058 * @throws SystemException if a system exception occurred 2059 */ 2060 @Override 2061 public void restoreFolderFromTrash(long folderId) 2062 throws com.liferay.portal.kernel.exception.PortalException, 2063 com.liferay.portal.kernel.exception.SystemException { 2064 _dlAppService.restoreFolderFromTrash(folderId); 2065 } 2066 2067 /** 2068 * Reverts the file entry to a previous version. A new version will be 2069 * created based on the previous version and metadata. 2070 * 2071 * @param fileEntryId the primary key of the file entry 2072 * @param version the version to revert back to 2073 * @param serviceContext the service context to be applied 2074 * @throws PortalException if the file entry or version could not be found 2075 * @throws SystemException if a system exception occurred 2076 */ 2077 @Override 2078 public void revertFileEntry(long fileEntryId, java.lang.String version, 2079 com.liferay.portal.service.ServiceContext serviceContext) 2080 throws com.liferay.portal.kernel.exception.PortalException, 2081 com.liferay.portal.kernel.exception.SystemException { 2082 _dlAppService.revertFileEntry(fileEntryId, version, serviceContext); 2083 } 2084 2085 @Override 2086 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 2087 long creatorUserId, int status, int start, int end) 2088 throws com.liferay.portal.kernel.exception.PortalException, 2089 com.liferay.portal.kernel.exception.SystemException { 2090 return _dlAppService.search(repositoryId, creatorUserId, status, start, 2091 end); 2092 } 2093 2094 @Override 2095 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 2096 long creatorUserId, long folderId, java.lang.String[] mimeTypes, 2097 int status, int start, int end) 2098 throws com.liferay.portal.kernel.exception.PortalException, 2099 com.liferay.portal.kernel.exception.SystemException { 2100 return _dlAppService.search(repositoryId, creatorUserId, folderId, 2101 mimeTypes, status, start, end); 2102 } 2103 2104 @Override 2105 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 2106 com.liferay.portal.kernel.search.SearchContext searchContext) 2107 throws com.liferay.portal.kernel.search.SearchException { 2108 return _dlAppService.search(repositoryId, searchContext); 2109 } 2110 2111 @Override 2112 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 2113 com.liferay.portal.kernel.search.SearchContext searchContext, 2114 com.liferay.portal.kernel.search.Query query) 2115 throws com.liferay.portal.kernel.search.SearchException { 2116 return _dlAppService.search(repositoryId, searchContext, query); 2117 } 2118 2119 /** 2120 * Subscribe the user to changes in documents of the file entry type. This 2121 * method is only supported by the Liferay repository. 2122 * 2123 * @param groupId the primary key of the file entry type's group 2124 * @param fileEntryTypeId the primary key of the file entry type 2125 * @throws PortalException if the user or group could not be found, or if 2126 subscribing was not permissible 2127 * @throws SystemException if a system exception occurred 2128 */ 2129 @Override 2130 public void subscribeFileEntryType(long groupId, long fileEntryTypeId) 2131 throws com.liferay.portal.kernel.exception.PortalException, 2132 com.liferay.portal.kernel.exception.SystemException { 2133 _dlAppService.subscribeFileEntryType(groupId, fileEntryTypeId); 2134 } 2135 2136 /** 2137 * Subscribe the user to document changes in the folder. This method is only 2138 * supported by the Liferay repository. 2139 * 2140 * @param groupId the primary key of the folder's group 2141 * @param folderId the primary key of the folder 2142 * @throws PortalException if the user or group could not be found, or if 2143 subscribing was not permissible 2144 * @throws SystemException if a system exception occurred 2145 */ 2146 @Override 2147 public void subscribeFolder(long groupId, long folderId) 2148 throws com.liferay.portal.kernel.exception.PortalException, 2149 com.liferay.portal.kernel.exception.SystemException { 2150 _dlAppService.subscribeFolder(groupId, folderId); 2151 } 2152 2153 /** 2154 * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long, 2155 boolean, String, ServiceContext)}. 2156 */ 2157 @Override 2158 public void unlockFileEntry(long fileEntryId) 2159 throws com.liferay.portal.kernel.exception.PortalException, 2160 com.liferay.portal.kernel.exception.SystemException { 2161 _dlAppService.unlockFileEntry(fileEntryId); 2162 } 2163 2164 /** 2165 * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long, 2166 String)}. 2167 */ 2168 @Override 2169 public void unlockFileEntry(long fileEntryId, java.lang.String lockUuid) 2170 throws com.liferay.portal.kernel.exception.PortalException, 2171 com.liferay.portal.kernel.exception.SystemException { 2172 _dlAppService.unlockFileEntry(fileEntryId, lockUuid); 2173 } 2174 2175 /** 2176 * Unlocks the folder. This method is primarily used by WebDAV. 2177 * 2178 * @param repositoryId the primary key of the repository 2179 * @param folderId the primary key of the folder 2180 * @param lockUuid the lock's UUID 2181 * @throws PortalException if the repository or folder could not be found 2182 * @throws SystemException if a system exception occurred 2183 */ 2184 @Override 2185 public void unlockFolder(long repositoryId, long folderId, 2186 java.lang.String lockUuid) 2187 throws com.liferay.portal.kernel.exception.PortalException, 2188 com.liferay.portal.kernel.exception.SystemException { 2189 _dlAppService.unlockFolder(repositoryId, folderId, lockUuid); 2190 } 2191 2192 /** 2193 * Unlocks the folder. This method is primarily used by WebDAV. 2194 * 2195 * @param repositoryId the primary key of the repository 2196 * @param parentFolderId the primary key of the parent folder 2197 * @param name the folder's name 2198 * @param lockUuid the lock's UUID 2199 * @throws PortalException if the repository or folder could not be found 2200 * @throws SystemException if a system exception occurred 2201 */ 2202 @Override 2203 public void unlockFolder(long repositoryId, long parentFolderId, 2204 java.lang.String name, java.lang.String lockUuid) 2205 throws com.liferay.portal.kernel.exception.PortalException, 2206 com.liferay.portal.kernel.exception.SystemException { 2207 _dlAppService.unlockFolder(repositoryId, parentFolderId, name, lockUuid); 2208 } 2209 2210 /** 2211 * Unsubscribe the user from changes in documents of the file entry type. 2212 * This method is only supported by the Liferay repository. 2213 * 2214 * @param groupId the primary key of the file entry type's group 2215 * @param fileEntryTypeId the primary key of the file entry type 2216 * @throws PortalException if the user or group could not be found, or if 2217 unsubscribing was not permissible 2218 * @throws SystemException if a system exception occurred 2219 */ 2220 @Override 2221 public void unsubscribeFileEntryType(long groupId, long fileEntryTypeId) 2222 throws com.liferay.portal.kernel.exception.PortalException, 2223 com.liferay.portal.kernel.exception.SystemException { 2224 _dlAppService.unsubscribeFileEntryType(groupId, fileEntryTypeId); 2225 } 2226 2227 /** 2228 * Unsubscribe the user from document changes in the folder. This method is 2229 * only supported by the Liferay repository. 2230 * 2231 * @param groupId the primary key of the folder's group 2232 * @param folderId the primary key of the folder 2233 * @throws PortalException if the user or group could not be found, or if 2234 unsubscribing was not permissible 2235 * @throws SystemException if a system exception occurred 2236 */ 2237 @Override 2238 public void unsubscribeFolder(long groupId, long folderId) 2239 throws com.liferay.portal.kernel.exception.PortalException, 2240 com.liferay.portal.kernel.exception.SystemException { 2241 _dlAppService.unsubscribeFolder(groupId, folderId); 2242 } 2243 2244 /** 2245 * Updates a file entry and associated metadata based on a byte array 2246 * object. If the file data is <code>null</code>, then only the associated 2247 * metadata (i.e., <code>title</code>, <code>description</code>, and 2248 * parameters in the <code>serviceContext</code>) will be updated. 2249 * 2250 * <p> 2251 * This method takes two file names, the <code>sourceFileName</code> and the 2252 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 2253 * name of the actual file being uploaded. The <code>title</code> 2254 * corresponds to a name the client wishes to assign this file after it has 2255 * been uploaded to the portal. 2256 * </p> 2257 * 2258 * @param fileEntryId the primary key of the file entry 2259 * @param sourceFileName the original file's name (optionally 2260 <code>null</code>) 2261 * @param mimeType the file's MIME type (optionally <code>null</code>) 2262 * @param title the new name to be assigned to the file (optionally <code> 2263 <code>null</code></code>) 2264 * @param description the file's new description 2265 * @param changeLog the file's version change log (optionally 2266 <code>null</code>) 2267 * @param majorVersion whether the new file version is a major version 2268 * @param bytes the file's data (optionally <code>null</code>) 2269 * @param serviceContext the service context to be applied. Can set the 2270 asset category IDs, asset tag names, and expando bridge 2271 attributes for the file entry. In a Liferay repository, it may 2272 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 2273 type </li> <li> fieldsMap - mapping for fields associated with a 2274 custom file entry type </li> </ul> 2275 * @return the file entry 2276 * @throws PortalException if the file entry could not be found 2277 * @throws SystemException if a system exception occurred 2278 */ 2279 @Override 2280 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 2281 long fileEntryId, java.lang.String sourceFileName, 2282 java.lang.String mimeType, java.lang.String title, 2283 java.lang.String description, java.lang.String changeLog, 2284 boolean majorVersion, byte[] bytes, 2285 com.liferay.portal.service.ServiceContext serviceContext) 2286 throws com.liferay.portal.kernel.exception.PortalException, 2287 com.liferay.portal.kernel.exception.SystemException { 2288 return _dlAppService.updateFileEntry(fileEntryId, sourceFileName, 2289 mimeType, title, description, changeLog, majorVersion, bytes, 2290 serviceContext); 2291 } 2292 2293 /** 2294 * Updates a file entry and associated metadata based on a {@link 2295 * java.io.File} object. If the file data is <code>null</code>, then only 2296 * the associated metadata (i.e., <code>title</code>, 2297 * <code>description</code>, and parameters in the 2298 * <code>serviceContext</code>) will be updated. 2299 * 2300 * <p> 2301 * This method takes two file names, the <code>sourceFileName</code> and the 2302 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 2303 * name of the actual file being uploaded. The <code>title</code> 2304 * corresponds to a name the client wishes to assign this file after it has 2305 * been uploaded to the portal. 2306 * </p> 2307 * 2308 * @param fileEntryId the primary key of the file entry 2309 * @param sourceFileName the original file's name (optionally 2310 <code>null</code>) 2311 * @param mimeType the file's MIME type (optionally <code>null</code>) 2312 * @param title the new name to be assigned to the file (optionally <code> 2313 <code>null</code></code>) 2314 * @param description the file's new description 2315 * @param changeLog the file's version change log (optionally 2316 <code>null</code>) 2317 * @param majorVersion whether the new file version is a major version 2318 * @param file EntryId the primary key of the file entry 2319 * @param serviceContext the service context to be applied. Can set the 2320 asset category IDs, asset tag names, and expando bridge 2321 attributes for the file entry. In a Liferay repository, it may 2322 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 2323 type </li> <li> fieldsMap - mapping for fields associated with a 2324 custom file entry type </li> </ul> 2325 * @return the file entry 2326 * @throws PortalException if the file entry could not be found 2327 * @throws SystemException if a system exception occurred 2328 */ 2329 @Override 2330 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 2331 long fileEntryId, java.lang.String sourceFileName, 2332 java.lang.String mimeType, java.lang.String title, 2333 java.lang.String description, java.lang.String changeLog, 2334 boolean majorVersion, java.io.File file, 2335 com.liferay.portal.service.ServiceContext serviceContext) 2336 throws com.liferay.portal.kernel.exception.PortalException, 2337 com.liferay.portal.kernel.exception.SystemException { 2338 return _dlAppService.updateFileEntry(fileEntryId, sourceFileName, 2339 mimeType, title, description, changeLog, majorVersion, file, 2340 serviceContext); 2341 } 2342 2343 /** 2344 * Updates a file entry and associated metadata based on an {@link java.io. 2345 * InputStream} object. If the file data is <code>null</code>, then only the 2346 * associated metadata (i.e., <code>title</code>, <code>description</code>, 2347 * and parameters in the <code>serviceContext</code>) will be updated. 2348 * 2349 * <p> 2350 * This method takes two file names, the <code>sourceFileName</code> and the 2351 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 2352 * name of the actual file being uploaded. The <code>title</code> 2353 * corresponds to a name the client wishes to assign this file after it has 2354 * been uploaded to the portal. 2355 * </p> 2356 * 2357 * @param fileEntryId the primary key of the file entry 2358 * @param sourceFileName the original file's name (optionally 2359 <code>null</code>) 2360 * @param mimeType the file's MIME type (optionally <code>null</code>) 2361 * @param title the new name to be assigned to the file (optionally <code> 2362 <code>null</code></code>) 2363 * @param description the file's new description 2364 * @param changeLog the file's version change log (optionally 2365 <code>null</code>) 2366 * @param majorVersion whether the new file version is a major version 2367 * @param is the file's data (optionally <code>null</code>) 2368 * @param size the file's size (optionally <code>0</code>) 2369 * @param serviceContext the service context to be applied. Can set the 2370 asset category IDs, asset tag names, and expando bridge 2371 attributes for the file entry. In a Liferay repository, it may 2372 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 2373 type </li> <li> fieldsMap - mapping for fields associated with a 2374 custom file entry type </li> </ul> 2375 * @return the file entry 2376 * @throws PortalException if the file entry could not be found 2377 * @throws SystemException if a system exception occurred 2378 */ 2379 @Override 2380 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 2381 long fileEntryId, java.lang.String sourceFileName, 2382 java.lang.String mimeType, java.lang.String title, 2383 java.lang.String description, java.lang.String changeLog, 2384 boolean majorVersion, java.io.InputStream is, long size, 2385 com.liferay.portal.service.ServiceContext serviceContext) 2386 throws com.liferay.portal.kernel.exception.PortalException, 2387 com.liferay.portal.kernel.exception.SystemException { 2388 return _dlAppService.updateFileEntry(fileEntryId, sourceFileName, 2389 mimeType, title, description, changeLog, majorVersion, is, size, 2390 serviceContext); 2391 } 2392 2393 @Override 2394 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn( 2395 long fileEntryId, java.lang.String sourceFileName, 2396 java.lang.String mimeType, java.lang.String title, 2397 java.lang.String description, java.lang.String changeLog, 2398 boolean majorVersion, java.io.File file, 2399 com.liferay.portal.service.ServiceContext serviceContext) 2400 throws com.liferay.portal.kernel.exception.PortalException, 2401 com.liferay.portal.kernel.exception.SystemException { 2402 return _dlAppService.updateFileEntryAndCheckIn(fileEntryId, 2403 sourceFileName, mimeType, title, description, changeLog, 2404 majorVersion, file, serviceContext); 2405 } 2406 2407 @Override 2408 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn( 2409 long fileEntryId, java.lang.String sourceFileName, 2410 java.lang.String mimeType, java.lang.String title, 2411 java.lang.String description, java.lang.String changeLog, 2412 boolean majorVersion, java.io.InputStream is, long size, 2413 com.liferay.portal.service.ServiceContext serviceContext) 2414 throws com.liferay.portal.kernel.exception.PortalException, 2415 com.liferay.portal.kernel.exception.SystemException { 2416 return _dlAppService.updateFileEntryAndCheckIn(fileEntryId, 2417 sourceFileName, mimeType, title, description, changeLog, 2418 majorVersion, is, size, serviceContext); 2419 } 2420 2421 /** 2422 * Updates a file shortcut to the existing file entry. This method is only 2423 * supported by the Liferay repository. 2424 * 2425 * @param fileShortcutId the primary key of the file shortcut 2426 * @param folderId the primary key of the file shortcut's parent folder 2427 * @param toFileEntryId the primary key of the file shortcut's file entry 2428 * @param serviceContext the service context to be applied. Can set the 2429 asset category IDs, asset tag names, and expando bridge 2430 attributes for the file entry. 2431 * @return the file shortcut 2432 * @throws PortalException if the file shortcut, folder, or file entry could 2433 not be found 2434 * @throws SystemException if a system exception occurred 2435 */ 2436 @Override 2437 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 2438 long fileShortcutId, long folderId, long toFileEntryId, 2439 com.liferay.portal.service.ServiceContext serviceContext) 2440 throws com.liferay.portal.kernel.exception.PortalException, 2441 com.liferay.portal.kernel.exception.SystemException { 2442 return _dlAppService.updateFileShortcut(fileShortcutId, folderId, 2443 toFileEntryId, serviceContext); 2444 } 2445 2446 /** 2447 * Updates the folder. 2448 * 2449 * @param folderId the primary key of the folder 2450 * @param name the folder's new name 2451 * @param description the folder's new description 2452 * @param serviceContext the service context to be applied. In a Liferay 2453 repository, it may include: <ul> <li> defaultFileEntryTypeId - 2454 the file entry type to default all Liferay file entries to </li> 2455 <li> dlFileEntryTypesSearchContainerPrimaryKeys - a 2456 comma-delimited list of file entry type primary keys allowed in 2457 the given folder and all descendants </li> <li> 2458 overrideFileEntryTypes - boolean specifying whether to override 2459 ancestral folder's restriction of file entry types allowed </li> 2460 <li> workflowDefinitionXYZ - the workflow definition name 2461 specified per file entry type. The parameter name must be the 2462 string <code>workflowDefinition</code> appended by the <code> 2463 fileEntryTypeId</code> (optionally <code>0</code>). </li> </ul> 2464 * @return the folder 2465 * @throws PortalException if the current or new parent folder could not be 2466 found or if the new parent folder's information was invalid 2467 * @throws SystemException if a system exception occurred 2468 */ 2469 @Override 2470 public com.liferay.portal.kernel.repository.model.Folder updateFolder( 2471 long folderId, java.lang.String name, java.lang.String description, 2472 com.liferay.portal.service.ServiceContext serviceContext) 2473 throws com.liferay.portal.kernel.exception.PortalException, 2474 com.liferay.portal.kernel.exception.SystemException { 2475 return _dlAppService.updateFolder(folderId, name, description, 2476 serviceContext); 2477 } 2478 2479 /** 2480 * Returns <code>true</code> if the file entry is checked out. This method 2481 * is primarily used by WebDAV. 2482 * 2483 * @param repositoryId the primary key for the repository 2484 * @param fileEntryId the primary key for the file entry 2485 * @param lockUuid the lock's UUID 2486 * @return <code>true</code> if the file entry is checked out; 2487 <code>false</code> otherwise 2488 * @throws PortalException if the file entry could not be found 2489 * @throws SystemException if a system exception occurred 2490 */ 2491 @Override 2492 public boolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId, 2493 java.lang.String lockUuid) 2494 throws com.liferay.portal.kernel.exception.PortalException, 2495 com.liferay.portal.kernel.exception.SystemException { 2496 return _dlAppService.verifyFileEntryCheckOut(repositoryId, fileEntryId, 2497 lockUuid); 2498 } 2499 2500 @Override 2501 public boolean verifyFileEntryLock(long repositoryId, long fileEntryId, 2502 java.lang.String lockUuid) 2503 throws com.liferay.portal.kernel.exception.PortalException, 2504 com.liferay.portal.kernel.exception.SystemException { 2505 return _dlAppService.verifyFileEntryLock(repositoryId, fileEntryId, 2506 lockUuid); 2507 } 2508 2509 /** 2510 * Returns <code>true</code> if the inheritable lock exists. This method is 2511 * primarily used by WebDAV. 2512 * 2513 * @param repositoryId the primary key for the repository 2514 * @param folderId the primary key for the folder 2515 * @param lockUuid the lock's UUID 2516 * @return <code>true</code> if the inheritable lock exists; 2517 <code>false</code> otherwise 2518 * @throws PortalException if the folder could not be found 2519 * @throws SystemException if a system exception occurred 2520 */ 2521 @Override 2522 public boolean verifyInheritableLock(long repositoryId, long folderId, 2523 java.lang.String lockUuid) 2524 throws com.liferay.portal.kernel.exception.PortalException, 2525 com.liferay.portal.kernel.exception.SystemException { 2526 return _dlAppService.verifyInheritableLock(repositoryId, folderId, 2527 lockUuid); 2528 } 2529 2530 /** 2531 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 2532 */ 2533 public DLAppService getWrappedDLAppService() { 2534 return _dlAppService; 2535 } 2536 2537 /** 2538 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 2539 */ 2540 public void setWrappedDLAppService(DLAppService dlAppService) { 2541 _dlAppService = dlAppService; 2542 } 2543 2544 @Override 2545 public DLAppService getWrappedService() { 2546 return _dlAppService; 2547 } 2548 2549 @Override 2550 public void setWrappedService(DLAppService dlAppService) { 2551 _dlAppService = dlAppService; 2552 } 2553 2554 private DLAppService _dlAppService; 2555 }