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