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