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