001 /** 002 * Copyright (c) 2000-2011 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 * <p> 021 * This class is a wrapper for {@link DLAppService}. 022 * </p> 023 * 024 * @author Brian Wing Shun Chan 025 * @see DLAppService 026 * @generated 027 */ 028 public class DLAppServiceWrapper implements DLAppService, 029 ServiceWrapper<DLAppService> { 030 public DLAppServiceWrapper(DLAppService dlAppService) { 031 _dlAppService = dlAppService; 032 } 033 034 /** 035 * Adds a file entry and associated metadata. It is created based on a byte 036 * array. 037 * 038 * <p> 039 * This method takes two file names, the <code>sourceFileName</code> and the 040 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 041 * name of the actual file being uploaded. The <code>title</code> 042 * corresponds to a name the client wishes to assign this file after it has 043 * been uploaded to the portal. If it is <code>null</code>, the <code> 044 * sourceFileName</code> will be used. 045 * </p> 046 * 047 * @param repositoryId the primary key of the repository 048 * @param folderId the primary key of the file entry's parent folder 049 * @param sourceFileName the original file's name 050 * @param mimeType the file's MIME type 051 * @param title the name to be assigned to the file (optionally <code>null 052 </code>) 053 * @param description the file's description 054 * @param changeLog the file's version change log 055 * @param bytes the file's data (optionally <code>null</code>) 056 * @param serviceContext the service context to be applied. Can set the 057 asset category IDs, asset tag names, and expando bridge 058 attributes for the file entry. In a Liferay repository, it may 059 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 060 type </li> <li> fieldsMap - mapping for fields associated with a 061 custom file entry type </li> </ul> 062 * @return the file entry 063 * @throws PortalException if the parent folder could not be found or if the 064 file entry's information was invalid 065 * @throws SystemException if a system exception occurred 066 */ 067 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 068 long repositoryId, long folderId, java.lang.String sourceFileName, 069 java.lang.String mimeType, java.lang.String title, 070 java.lang.String description, java.lang.String changeLog, byte[] bytes, 071 com.liferay.portal.service.ServiceContext serviceContext) 072 throws com.liferay.portal.kernel.exception.PortalException, 073 com.liferay.portal.kernel.exception.SystemException { 074 return _dlAppService.addFileEntry(repositoryId, folderId, 075 sourceFileName, mimeType, title, description, changeLog, bytes, 076 serviceContext); 077 } 078 079 /** 080 * Adds a file entry and associated metadata. It is created based on a 081 * {@link File} object. 082 * 083 * <p> 084 * This method takes two file names, the <code>sourceFileName</code> and the 085 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 086 * name of the actual file being uploaded. The <code>title</code> 087 * corresponds to a name the client wishes to assign this file after it has 088 * been uploaded to the portal. If it is <code>null</code>, the <code> 089 * sourceFileName</code> will be used. 090 * </p> 091 * 092 * @param repositoryId the primary key of the repository 093 * @param folderId the primary key of the file entry's parent folder 094 * @param sourceFileName the original file's name 095 * @param mimeType the file's MIME type 096 * @param title the name to be assigned to the file (optionally <code>null 097 </code>) 098 * @param description the file's description 099 * @param changeLog the file's version change log 100 * @param file the file's data (optionally <code>null</code>) 101 * @param serviceContext the service context to be applied. Can set the 102 asset category IDs, asset tag names, and expando bridge 103 attributes for the file entry. In a Liferay repository, it may 104 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 105 type </li> <li> fieldsMap - mapping for fields associated with a 106 custom file entry type </li> </ul> 107 * @return the file entry 108 * @throws PortalException if the parent folder could not be found or if the 109 file entry's information was invalid 110 * @throws SystemException if a system exception occurred 111 */ 112 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 113 long repositoryId, long folderId, java.lang.String sourceFileName, 114 java.lang.String mimeType, java.lang.String title, 115 java.lang.String description, java.lang.String changeLog, 116 java.io.File file, 117 com.liferay.portal.service.ServiceContext serviceContext) 118 throws com.liferay.portal.kernel.exception.PortalException, 119 com.liferay.portal.kernel.exception.SystemException { 120 return _dlAppService.addFileEntry(repositoryId, folderId, 121 sourceFileName, mimeType, title, description, changeLog, file, 122 serviceContext); 123 } 124 125 /** 126 * Adds a file entry and associated metadata. It is created based on a 127 * {@link InputStream} object. 128 * 129 * <p> 130 * This method takes two file names, the <code>sourceFileName</code> and the 131 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 132 * name of the actual file being uploaded. The <code>title</code> 133 * corresponds to a name the client wishes to assign this file after it has 134 * been uploaded to the portal. If it is <code>null</code>, the <code> 135 * sourceFileName</code> will be used. 136 * </p> 137 * 138 * @param repositoryId the primary key of the repository 139 * @param folderId the primary key of the file entry's parent folder 140 * @param sourceFileName the original file's name 141 * @param mimeType the file's MIME type 142 * @param title the name to be assigned to the file (optionally <code>null 143 </code>) 144 * @param description the file's description 145 * @param changeLog the file's version change log 146 * @param is the file's data (optionally <code>null</code>) 147 * @param size the file's size (optionally <code>0</code>) 148 * @param serviceContext the service context to be applied. Can set the 149 asset category IDs, asset tag names, and expando bridge 150 attributes for the file entry. In a Liferay repository, it may 151 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 152 type </li> <li> fieldsMap - mapping for fields associated with a 153 custom file entry type </li> </ul> 154 * @return the file entry 155 * @throws PortalException if the parent folder could not be found or if the 156 file entry's information was invalid 157 * @throws SystemException if a system exception occurred 158 */ 159 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 160 long repositoryId, long folderId, java.lang.String sourceFileName, 161 java.lang.String mimeType, java.lang.String title, 162 java.lang.String description, java.lang.String changeLog, 163 java.io.InputStream is, long size, 164 com.liferay.portal.service.ServiceContext serviceContext) 165 throws com.liferay.portal.kernel.exception.PortalException, 166 com.liferay.portal.kernel.exception.SystemException { 167 return _dlAppService.addFileEntry(repositoryId, folderId, 168 sourceFileName, mimeType, title, description, changeLog, is, size, 169 serviceContext); 170 } 171 172 /** 173 * Adds a file shortcut to the existing file entry. This method is only 174 * supported by the Liferay repository. 175 * 176 * @param repositoryId the primary key of the repository 177 * @param folderId the primary key of the file shortcut's parent folder 178 * @param toFileEntryId the primary key of the file shortcut's file entry 179 * @param serviceContext the service context to be applied. Can set the 180 asset category IDs, asset tag names, and expando bridge 181 attributes for the file entry. 182 * @return the file shortcut 183 * @throws PortalException if the parent folder or file entry could not be 184 found, or if the file shortcut's information was invalid 185 * @throws SystemException if a system exception occurred 186 */ 187 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 188 long repositoryId, long folderId, long toFileEntryId, 189 com.liferay.portal.service.ServiceContext serviceContext) 190 throws com.liferay.portal.kernel.exception.PortalException, 191 com.liferay.portal.kernel.exception.SystemException { 192 return _dlAppService.addFileShortcut(repositoryId, folderId, 193 toFileEntryId, serviceContext); 194 } 195 196 /** 197 * Adds a folder. 198 * 199 * @param repositoryId the primary key of the repository 200 * @param parentFolderId the primary key of the folder's parent folder 201 * @param name the folder's name 202 * @param description the folder's description 203 * @param serviceContext the service context to be applied. In a Liferay 204 repository, it may include boolean mountPoint specifying whether 205 folder is a facade for mounting a third-party repository 206 * @return the folder 207 * @throws PortalException if the parent folder could not be found or if the 208 new folder's information was invalid 209 * @throws SystemException if a system exception occurred 210 */ 211 public com.liferay.portal.kernel.repository.model.Folder addFolder( 212 long repositoryId, long parentFolderId, java.lang.String name, 213 java.lang.String description, 214 com.liferay.portal.service.ServiceContext serviceContext) 215 throws com.liferay.portal.kernel.exception.PortalException, 216 com.liferay.portal.kernel.exception.SystemException { 217 return _dlAppService.addFolder(repositoryId, parentFolderId, name, 218 description, serviceContext); 219 } 220 221 /** 222 * Adds a temporary file entry. 223 * 224 * <p> 225 * This allows a client to upload a file into a temporary location and 226 * manipulate its metadata prior to making it available for public usage. 227 * This is different from checking in and checking out a file entry. 228 * </p> 229 * 230 * @param groupId the primary key of the group 231 * @param folderId the primary key of the folder where the file entry will 232 eventually reside 233 * @param fileName the file's original name 234 * @param tempFolderName the temporary folder's name 235 * @param file Name the file's original name 236 * @return the file's name 237 * @throws IOException if a problem occurred in the access or storage of the 238 file 239 * @throws PortalException if the file name was invalid 240 * @throws SystemException if a system exception occurred 241 * @see com.liferay.portal.kernel.util.TempFileUtil 242 */ 243 public java.lang.String addTempFileEntry(long groupId, long folderId, 244 java.lang.String fileName, java.lang.String tempFolderName, 245 java.io.File file) 246 throws com.liferay.portal.kernel.exception.PortalException, 247 com.liferay.portal.kernel.exception.SystemException, 248 java.io.IOException { 249 return _dlAppService.addTempFileEntry(groupId, folderId, fileName, 250 tempFolderName, file); 251 } 252 253 public java.lang.String addTempFileEntry(long groupId, long folderId, 254 java.lang.String fileName, java.lang.String tempFolderName, 255 java.io.InputStream inputStream) 256 throws com.liferay.portal.kernel.exception.PortalException, 257 com.liferay.portal.kernel.exception.SystemException, 258 java.io.IOException { 259 return _dlAppService.addTempFileEntry(groupId, folderId, fileName, 260 tempFolderName, inputStream); 261 } 262 263 /** 264 * Cancels the check out of the file entry. If a user has not checked out 265 * the specified file entry, invoking this method will result in no changes. 266 * 267 * <p> 268 * When a file entry is checked out, a PWC (private working copy) is created 269 * and the original file entry is locked. A client can make as many changes 270 * to the PWC as he desires without those changes being visible to other 271 * users. If the user is satisfied with the changes, he may elect to check 272 * in his changes, resulting in a new file version based on the PWC; the PWC 273 * will be removed and the file entry will be unlocked. If the user is not 274 * satisfied with the changes, he may elect to cancel his check out; this 275 * results in the deletion of the PWC and unlocking of the file entry. 276 * </p> 277 * 278 * @param fileEntryId the primary key of the file entry to cancel the 279 checkout 280 * @throws PortalException if the file entry could not be found 281 * @throws SystemException if a system exception occurred 282 * @see #checkInFileEntry(long, boolean, String, ServiceContext) 283 * @see #checkOutFileEntry(long) 284 */ 285 public void cancelCheckOut(long fileEntryId) 286 throws com.liferay.portal.kernel.exception.PortalException, 287 com.liferay.portal.kernel.exception.SystemException { 288 _dlAppService.cancelCheckOut(fileEntryId); 289 } 290 291 /** 292 * Checks in the file entry. If a user has not checked out the specified 293 * file entry, invoking this method will result in no changes. 294 * 295 * <p> 296 * When a file entry is checked out, a PWC (private working copy) is created 297 * and the original file entry is locked. A client can make as many changes 298 * to the PWC as he desires without those changes being visible to other 299 * users. If the user is satisfied with the changes, he may elect to check 300 * in his changes, resulting in a new file version based on the PWC; the PWC 301 * will be removed and the file entry will be unlocked. If the user is not 302 * satisfied with the changes, he may elect to cancel his check out; this 303 * results in the deletion of the PWC and unlocking of the file entry. 304 * </p> 305 * 306 * @param fileEntryId the primary key of the file entry to check in 307 * @param majorVersion whether the new file version is a major version 308 * @param changeLog the file's version change log 309 * @param serviceContext the service context to be applied 310 * @throws PortalException if the file entry could not be found 311 * @throws SystemException if a system exception occurred 312 * @see #cancelCheckOut(long) 313 * @see #checkOutFileEntry(long) 314 */ 315 public void checkInFileEntry(long fileEntryId, boolean majorVersion, 316 java.lang.String changeLog, 317 com.liferay.portal.service.ServiceContext serviceContext) 318 throws com.liferay.portal.kernel.exception.PortalException, 319 com.liferay.portal.kernel.exception.SystemException { 320 _dlAppService.checkInFileEntry(fileEntryId, majorVersion, changeLog, 321 serviceContext); 322 } 323 324 /** 325 * Checks in the file entry using the lock's UUID. If a user has not checked 326 * out the specified file entry, invoking this method will result in no 327 * changes. This method is primarily used by WebDAV. 328 * 329 * <p> 330 * When a file entry is checked out, a PWC (private working copy) is created 331 * and the original file entry is locked. A client can make as many changes 332 * to the PWC as he desires without those changes being visible to other 333 * users. If the user is satisfied with the changes, he may elect to check 334 * in his changes, resulting in a new file version based on the PWC; the PWC 335 * will be removed and the file entry will be unlocked. If the user is not 336 * satisfied with the changes, he may elect to cancel his check out; this 337 * results in the deletion of the PWC and unlocking of the file entry. 338 * </p> 339 * 340 * @param fileEntryId the primary key of the file entry to check in 341 * @param lockUuid the lock's universally unique identifier 342 * @throws PortalException if the file entry could not be found 343 * @throws SystemException if a system exception occurred 344 * @see #cancelCheckOut(long) 345 * @see #checkOutFileEntry(long, String, long) 346 */ 347 public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid) 348 throws com.liferay.portal.kernel.exception.PortalException, 349 com.liferay.portal.kernel.exception.SystemException { 350 _dlAppService.checkInFileEntry(fileEntryId, lockUuid); 351 } 352 353 /** 354 * Check out a file entry. 355 * 356 * <p> 357 * When a file entry is checked out, a PWC (private working copy) is created 358 * and the original file entry is locked. A client can make as many changes 359 * to the PWC as he desires without those changes being visible to other 360 * users. If the user is satisfied with the changes, he may elect to check 361 * in his changes, resulting in a new file version based on the PWC; the PWC 362 * will be removed and the file entry will be unlocked. If the user is not 363 * satisfied with the changes, he may elect to cancel his check out; this 364 * results in the deletion of the PWC and unlocking of the file entry. 365 * </p> 366 * 367 * @param fileEntryId the file entry to check out 368 * @throws PortalException if the file entry could not be found 369 * @throws SystemException if a system exception occurred 370 * @see #cancelCheckOut(long) 371 * @see #checkInFileEntry(long, boolean, String, ServiceContext) 372 */ 373 public void checkOutFileEntry(long fileEntryId) 374 throws com.liferay.portal.kernel.exception.PortalException, 375 com.liferay.portal.kernel.exception.SystemException { 376 _dlAppService.checkOutFileEntry(fileEntryId); 377 } 378 379 /** 380 * Checks out the file entry. This method is primarily used by WebDAV. 381 * 382 * <p> 383 * When a file entry is checked out, a PWC (private working copy) is created 384 * and the original file entry is locked. A client can make as many changes 385 * to the PWC as he desires without those changes being visible to other 386 * users. If the user is satisfied with the changes, he may elect to check 387 * in his changes, resulting in a new file version based on the PWC; the PWC 388 * will be removed and the file entry will be unlocked. If the user is not 389 * satisfied with the changes, he may elect to cancel his check out; this 390 * results in the deletion of the PWC and unlocking of the file entry. 391 * </p> 392 * 393 * @param fileEntryId the file entry to check out 394 * @param owner the owner string for the checkout (optionally 395 <code>null</code>) 396 * @param expirationTime the time in milliseconds before the lock expires. 397 If the value is <code>0</code>, the default expiration time will 398 be used from <code>portal.properties>. 399 * @return the file entry 400 * @throws PortalException if the file entry could not be found 401 * @throws SystemException if a system exception occurred 402 * @see #cancelCheckOut(long) 403 * @see #checkInFileEntry(long, String) 404 */ 405 public com.liferay.portal.kernel.repository.model.FileEntry checkOutFileEntry( 406 long fileEntryId, java.lang.String owner, long expirationTime) 407 throws com.liferay.portal.kernel.exception.PortalException, 408 com.liferay.portal.kernel.exception.SystemException { 409 return _dlAppService.checkOutFileEntry(fileEntryId, owner, 410 expirationTime); 411 } 412 413 /** 414 * Performs a deep copy of the folder. 415 * 416 * @param repositoryId the primary key of the repository 417 * @param sourceFolderId the primary key of the folder to copy 418 * @param parentFolderId the primary key of the new folder's parent folder 419 * @param name the new folder's name 420 * @param description the new folder's description 421 * @param serviceContext the service context to be applied 422 * @return the folder 423 * @throws PortalException if the source folder or the new parent folder 424 could not be found or if the new folder's information was invalid 425 * @throws SystemException if a system exception occurred 426 */ 427 public com.liferay.portal.kernel.repository.model.Folder copyFolder( 428 long repositoryId, long sourceFolderId, long parentFolderId, 429 java.lang.String name, java.lang.String description, 430 com.liferay.portal.service.ServiceContext serviceContext) 431 throws com.liferay.portal.kernel.exception.PortalException, 432 com.liferay.portal.kernel.exception.SystemException { 433 return _dlAppService.copyFolder(repositoryId, sourceFolderId, 434 parentFolderId, name, description, serviceContext); 435 } 436 437 /** 438 * Deletes the file entry with the primary key. 439 * 440 * @param fileEntryId the primary key of the file entry 441 * @throws PortalException if the file entry could not be found 442 * @throws SystemException if a system exception occurred 443 */ 444 public void deleteFileEntry(long fileEntryId) 445 throws com.liferay.portal.kernel.exception.PortalException, 446 com.liferay.portal.kernel.exception.SystemException { 447 _dlAppService.deleteFileEntry(fileEntryId); 448 } 449 450 /** 451 * Deletes the file entry with the title in the folder. 452 * 453 * @param repositoryId the primary key of the repository 454 * @param folderId the primary key of the file entry's parent folder 455 * @param title the file entry's title 456 * @throws PortalException if the file entry could not be found 457 * @throws SystemException if a system exception occurred 458 */ 459 public void deleteFileEntryByTitle(long repositoryId, long folderId, 460 java.lang.String title) 461 throws com.liferay.portal.kernel.exception.PortalException, 462 com.liferay.portal.kernel.exception.SystemException { 463 _dlAppService.deleteFileEntryByTitle(repositoryId, folderId, title); 464 } 465 466 /** 467 * Deletes the file shortcut with the primary key. This method is only 468 * supported by the Liferay repository. 469 * 470 * @param fileShortcutId the primary key of the file shortcut 471 * @throws PortalException if the file shortcut could not be found 472 * @throws SystemException if a system exception occurred 473 */ 474 public void deleteFileShortcut(long fileShortcutId) 475 throws com.liferay.portal.kernel.exception.PortalException, 476 com.liferay.portal.kernel.exception.SystemException { 477 _dlAppService.deleteFileShortcut(fileShortcutId); 478 } 479 480 /** 481 * Deletes the folder with the primary key and all of its subfolders and 482 * file entries. 483 * 484 * @param folderId the primary key of the folder 485 * @throws PortalException if the folder could not be found 486 * @throws SystemException if a system exception occurred 487 */ 488 public void deleteFolder(long folderId) 489 throws com.liferay.portal.kernel.exception.PortalException, 490 com.liferay.portal.kernel.exception.SystemException { 491 _dlAppService.deleteFolder(folderId); 492 } 493 494 /** 495 * Deletes the folder with the name in the parent folder and all of its 496 * subfolders and file entries. 497 * 498 * @param repositoryId the primary key of the repository 499 * @param parentFolderId the primary key of the folder's parent folder 500 * @param name the folder's name 501 * @throws PortalException if the folder could not be found 502 * @throws SystemException if a system exception occurred 503 */ 504 public void deleteFolder(long repositoryId, long parentFolderId, 505 java.lang.String name) 506 throws com.liferay.portal.kernel.exception.PortalException, 507 com.liferay.portal.kernel.exception.SystemException { 508 _dlAppService.deleteFolder(repositoryId, parentFolderId, name); 509 } 510 511 /** 512 * Deletes the temporary file entry. 513 * 514 * @param groupId the primary key of the group 515 * @param folderId the primary key of the folder where the file entry was 516 eventually to reside 517 * @param fileName the file's original name 518 * @param tempFolderName the temporary folder's name 519 * @throws PortalException if the file name was invalid 520 * @throws SystemException if a system exception occurred 521 * @see com.liferay.portal.kernel.util.TempFileUtil 522 */ 523 public void deleteTempFileEntry(long groupId, long folderId, 524 java.lang.String fileName, java.lang.String tempFolderName) 525 throws com.liferay.portal.kernel.exception.PortalException, 526 com.liferay.portal.kernel.exception.SystemException { 527 _dlAppService.deleteTempFileEntry(groupId, folderId, fileName, 528 tempFolderName); 529 } 530 531 /** 532 * Returns all the file entries in the folder. 533 * 534 * @param repositoryId the primary key of the file entry's repository 535 * @param folderId the primary key of the file entry's folder 536 * @return the file entries in the folder 537 * @throws PortalException if the folder could not be found 538 * @throws SystemException if a system exception occurred 539 */ 540 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 541 long repositoryId, long folderId) 542 throws com.liferay.portal.kernel.exception.PortalException, 543 com.liferay.portal.kernel.exception.SystemException { 544 return _dlAppService.getFileEntries(repositoryId, folderId); 545 } 546 547 /** 548 * Returns a range of all the file entries in the folder. 549 * 550 * <p> 551 * Useful when paginating results. Returns a maximum of <code>end - 552 * start</code> instances. <code>start</code> and <code>end</code> are not 553 * primary keys, they are indexes in the result set. Thus, <code>0</code> 554 * refers to the first result in the set. Setting both <code>start</code> 555 * and <code>end</code> to {@link 556 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 557 * result set. 558 * </p> 559 * 560 * @param repositoryId the primary key of the file entry's repository 561 * @param folderId the primary key of the file entry's folder 562 * @param start the lower bound of the range of results 563 * @param end the upper bound of the range of results (not inclusive) 564 * @return the range of file entries in the folder 565 * @throws PortalException if the folder could not be found 566 * @throws SystemException if a system exception occurred 567 */ 568 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 569 long repositoryId, long folderId, int start, int end) 570 throws com.liferay.portal.kernel.exception.PortalException, 571 com.liferay.portal.kernel.exception.SystemException { 572 return _dlAppService.getFileEntries(repositoryId, folderId, start, end); 573 } 574 575 /** 576 * Returns an ordered range of all the file entries in the folder. 577 * 578 * <p> 579 * Useful when paginating results. Returns a maximum of <code>end - 580 * start</code> instances. <code>start</code> and <code>end</code> are not 581 * primary keys, they are indexes in the result set. Thus, <code>0</code> 582 * refers to the first result in the set. Setting both <code>start</code> 583 * and <code>end</code> to {@link 584 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 585 * result set. 586 * </p> 587 * 588 * @param repositoryId the primary key of the file entry's repository 589 * @param folderId the primary key of the file entry's folder 590 * @param start the lower bound of the range of results 591 * @param end the upper bound of the range of results (not inclusive) 592 * @param obc the comparator to order the file entries (optionally 593 <code>null</code>) 594 * @return the range of file entries in the folder ordered by comparator 595 <code>obc</code> 596 * @throws PortalException if the folder could not be found 597 * @throws SystemException if a system exception occurred 598 */ 599 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 600 long repositoryId, long folderId, int start, int end, 601 com.liferay.portal.kernel.util.OrderByComparator obc) 602 throws com.liferay.portal.kernel.exception.PortalException, 603 com.liferay.portal.kernel.exception.SystemException { 604 return _dlAppService.getFileEntries(repositoryId, folderId, start, end, 605 obc); 606 } 607 608 /** 609 * Returns the file entries with the file entry type in the folder. 610 * 611 * @param repositoryId the primary key of the file entry's repository 612 * @param folderId the primary key of the file entry's folder 613 * @param fileEntryTypeId the primary key of the file entry type 614 * @return the file entries with the file entry type in the folder 615 * @throws PortalException if the folder could not be found 616 * @throws SystemException if a system exception occurred 617 */ 618 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 619 long repositoryId, long folderId, long fileEntryTypeId) 620 throws com.liferay.portal.kernel.exception.PortalException, 621 com.liferay.portal.kernel.exception.SystemException { 622 return _dlAppService.getFileEntries(repositoryId, folderId, 623 fileEntryTypeId); 624 } 625 626 /** 627 * Returns a range of all the file entries with the file entry type in the 628 * folder. 629 * 630 * @param repositoryId the primary key of the file entry's repository 631 * @param folderId the primary key of the file entry's folder 632 * @param fileEntryTypeId the primary key of the file entry type 633 * @param start the lower bound of the range of results 634 * @param end the upper bound of the range of results (not inclusive) 635 * @return the file entries in the folder 636 * @throws PortalException if the folder could not be found 637 * @throws SystemException if a system exception occurred 638 */ 639 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 640 long repositoryId, long folderId, long fileEntryTypeId, int start, 641 int end) 642 throws com.liferay.portal.kernel.exception.PortalException, 643 com.liferay.portal.kernel.exception.SystemException { 644 return _dlAppService.getFileEntries(repositoryId, folderId, 645 fileEntryTypeId, start, end); 646 } 647 648 /** 649 * Returns an ordered range of all the file entries with the file entry type 650 * in the folder. 651 * 652 * @param repositoryId the primary key of the repository 653 * @param folderId the primary key of the folder 654 * @param fileEntryTypeId the primary key of the file entry type 655 * @param start the lower bound of the range of results 656 * @param end the upper bound of the range of results (not inclusive) 657 * @param obc the comparator to order the results by (optionally 658 <code>null</code>) 659 * @return the range of file entries with the file entry type in the folder 660 ordered by <code>null</code> 661 * @throws PortalException if the folder could not be found 662 * @throws SystemException if a system exception occurred 663 */ 664 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries( 665 long repositoryId, long folderId, long fileEntryTypeId, int start, 666 int end, com.liferay.portal.kernel.util.OrderByComparator obc) 667 throws com.liferay.portal.kernel.exception.PortalException, 668 com.liferay.portal.kernel.exception.SystemException { 669 return _dlAppService.getFileEntries(repositoryId, folderId, 670 fileEntryTypeId, start, end, obc); 671 } 672 673 /** 674 * Returns a range of all the file entries and shortcuts in the folder. 675 * 676 * <p> 677 * Useful when paginating results. Returns a maximum of <code>end - 678 * start</code> instances. <code>start</code> and <code>end</code> are not 679 * primary keys, they are indexes in the result set. Thus, <code>0</code> 680 * refers to the first result in the set. Setting both <code>start</code> 681 * and <code>end</code> to {@link 682 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 683 * result set. 684 * </p> 685 * 686 * @param repositoryId the primary key of the repository 687 * @param folderId the primary key of the folder 688 * @param status the workflow status 689 * @param start the lower bound of the range of results 690 * @param end the upper bound of the range of results (not inclusive) 691 * @return the range of file entries and shortcuts in the folder 692 * @throws PortalException if the folder could not be found 693 * @throws SystemException if a system exception occurred 694 */ 695 public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts( 696 long repositoryId, long folderId, int status, int start, int end) 697 throws com.liferay.portal.kernel.exception.PortalException, 698 com.liferay.portal.kernel.exception.SystemException { 699 return _dlAppService.getFileEntriesAndFileShortcuts(repositoryId, 700 folderId, status, start, end); 701 } 702 703 /** 704 * Returns the number of file entries and shortcuts in the folder. 705 * 706 * @param repositoryId the primary key of the repository 707 * @param folderId the primary key of the folder 708 * @param status the workflow status 709 * @return the number of file entries and shortcuts in the folder 710 * @throws PortalException if the folder ould not be found 711 * @throws SystemException if a system exception occurred 712 */ 713 public int getFileEntriesAndFileShortcutsCount(long repositoryId, 714 long folderId, int status) 715 throws com.liferay.portal.kernel.exception.PortalException, 716 com.liferay.portal.kernel.exception.SystemException { 717 return _dlAppService.getFileEntriesAndFileShortcutsCount(repositoryId, 718 folderId, status); 719 } 720 721 /** 722 * Returns the number of file entries in the folder. 723 * 724 * @param repositoryId the primary key of the file entry's repository 725 * @param folderId the primary key of the file entry's folder 726 * @return the number of file entries in the folder 727 * @throws PortalException if the folder could not be found 728 * @throws SystemException if a system exception occurred 729 */ 730 public int getFileEntriesCount(long repositoryId, long folderId) 731 throws com.liferay.portal.kernel.exception.PortalException, 732 com.liferay.portal.kernel.exception.SystemException { 733 return _dlAppService.getFileEntriesCount(repositoryId, folderId); 734 } 735 736 /** 737 * Returns the number of file entries with the file entry type in the 738 * folder. 739 * 740 * @param repositoryId the primary key of the file entry's repository 741 * @param folderId the primary key of the file entry's folder 742 * @param fileEntryTypeId the primary key of the file entry type 743 * @return the number of file entries with the file entry type in the folder 744 * @throws PortalException if the folder could not be found 745 * @throws SystemException if a system exception occurred 746 */ 747 public int getFileEntriesCount(long repositoryId, long folderId, 748 long fileEntryTypeId) 749 throws com.liferay.portal.kernel.exception.PortalException, 750 com.liferay.portal.kernel.exception.SystemException { 751 return _dlAppService.getFileEntriesCount(repositoryId, folderId, 752 fileEntryTypeId); 753 } 754 755 /** 756 * Returns the file entry with the primary key. 757 * 758 * @param fileEntryId the primary key of the file entry 759 * @return the file entry with the primary key 760 * @throws PortalException if the file entry could not be found 761 * @throws SystemException if a system exception occurred 762 */ 763 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 764 long fileEntryId) 765 throws com.liferay.portal.kernel.exception.PortalException, 766 com.liferay.portal.kernel.exception.SystemException { 767 return _dlAppService.getFileEntry(fileEntryId); 768 } 769 770 /** 771 * Returns the file entry with the title in the folder. 772 * 773 * @param groupId the primary key of the file entry's group 774 * @param folderId the primary key of the file entry's folder 775 * @param title the file entry's title 776 * @return the file entry with the title in the folder 777 * @throws PortalException if the file entry could not be found 778 * @throws SystemException if a system exception occurred 779 */ 780 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 781 long groupId, long folderId, java.lang.String title) 782 throws com.liferay.portal.kernel.exception.PortalException, 783 com.liferay.portal.kernel.exception.SystemException { 784 return _dlAppService.getFileEntry(groupId, folderId, title); 785 } 786 787 /** 788 * Returns the file entry with the UUID and group. 789 * 790 * @param uuid the file entry's universally unique identifier 791 * @param groupId the primary key of the file entry's group 792 * @return the file entry with the UUID and group 793 * @throws PortalException if the file entry could not be found 794 * @throws SystemException if a system exception occurred 795 */ 796 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId( 797 java.lang.String uuid, long groupId) 798 throws com.liferay.portal.kernel.exception.PortalException, 799 com.liferay.portal.kernel.exception.SystemException { 800 return _dlAppService.getFileEntryByUuidAndGroupId(uuid, groupId); 801 } 802 803 /** 804 * Returns the file shortcut with the primary key. This method is only 805 * supported by the Liferay repository. 806 * 807 * @param fileShortcutId the primary key of the file shortcut 808 * @return the file shortcut with the primary key 809 * @throws PortalException if the file shortcut could not be found 810 * @throws SystemException if a system exception occurred 811 */ 812 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 813 long fileShortcutId) 814 throws com.liferay.portal.kernel.exception.PortalException, 815 com.liferay.portal.kernel.exception.SystemException { 816 return _dlAppService.getFileShortcut(fileShortcutId); 817 } 818 819 /** 820 * Returns the folder with the primary key. 821 * 822 * @param folderId the primary key of the folder 823 * @return the folder with the primary key 824 * @throws PortalException if the folder could not be found 825 * @throws SystemException if a system exception occurred 826 */ 827 public com.liferay.portal.kernel.repository.model.Folder getFolder( 828 long folderId) 829 throws com.liferay.portal.kernel.exception.PortalException, 830 com.liferay.portal.kernel.exception.SystemException { 831 return _dlAppService.getFolder(folderId); 832 } 833 834 /** 835 * Returns the folder with the name in the parent folder. 836 * 837 * @param repositoryId the primary key of the folder's repository 838 * @param parentFolderId the primary key of the folder's parent folder 839 * @param name the folder's name 840 * @return the folder with the name in the parent folder 841 * @throws PortalException if the folder could not be found 842 * @throws SystemException if a system exception occurred 843 */ 844 public com.liferay.portal.kernel.repository.model.Folder getFolder( 845 long repositoryId, long parentFolderId, java.lang.String name) 846 throws com.liferay.portal.kernel.exception.PortalException, 847 com.liferay.portal.kernel.exception.SystemException { 848 return _dlAppService.getFolder(repositoryId, parentFolderId, name); 849 } 850 851 /** 852 * Returns all immediate subfolders of the parent folder. 853 * 854 * @param repositoryId the primary key of the folder's repository 855 * @param parentFolderId the primary key of the folder's parent folder 856 * @return the immediate subfolders of the parent folder 857 * @throws PortalException if the parent folder could not be found 858 * @throws SystemException if a system exception occurred 859 */ 860 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 861 long repositoryId, long parentFolderId) 862 throws com.liferay.portal.kernel.exception.PortalException, 863 com.liferay.portal.kernel.exception.SystemException { 864 return _dlAppService.getFolders(repositoryId, parentFolderId); 865 } 866 867 /** 868 * Returns all immediate subfolders of the parent folder, optionally 869 * including mount folders for third-party repositories. 870 * 871 * @param repositoryId the primary key of the folder's repository 872 * @param parentFolderId the primary key of the folder's parent folder 873 * @param includeMountFolders whether to include mount folders for 874 third-party repositories 875 * @return the immediate subfolders of the parent folder 876 * @throws PortalException if the parent folder could not be found 877 * @throws SystemException if a system exception occurred 878 */ 879 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 880 long repositoryId, long parentFolderId, boolean includeMountFolders) 881 throws com.liferay.portal.kernel.exception.PortalException, 882 com.liferay.portal.kernel.exception.SystemException { 883 return _dlAppService.getFolders(repositoryId, parentFolderId, 884 includeMountFolders); 885 } 886 887 /** 888 * Returns a range of all the immediate subfolders of the parent folder, 889 * optionally including mount folders for third-party repositories. 890 * 891 * <p> 892 * Useful when paginating results. Returns a maximum of <code>end - 893 * start</code> instances. <code>start</code> and <code>end</code> are not 894 * primary keys, they are indexes in the result set. Thus, <code>0</code> 895 * refers to the first result in the set. Setting both <code>start</code> 896 * and <code>end</code> to {@link 897 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 898 * result set. 899 * </p> 900 * 901 * @param repositoryId the primary key of the folder's repository 902 * @param parentFolderId the primary key of the folder's parent folder 903 * @param includeMountFolders whether to include mount folders for 904 third-party repositories 905 * @param start the lower bound of the range of results 906 * @param end the upper bound of the range of results (not inclusive) 907 * @return the range of immediate subfolders of the parent folder 908 * @throws PortalException if the parent folder could not be found 909 * @throws SystemException if a system exception occurred 910 */ 911 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 912 long repositoryId, long parentFolderId, boolean includeMountFolders, 913 int start, int end) 914 throws com.liferay.portal.kernel.exception.PortalException, 915 com.liferay.portal.kernel.exception.SystemException { 916 return _dlAppService.getFolders(repositoryId, parentFolderId, 917 includeMountFolders, start, end); 918 } 919 920 /** 921 * Returns an ordered range of all the immediate subfolders of the parent 922 * folder. 923 * 924 * <p> 925 * Useful when paginating results. Returns a maximum of <code>end - 926 * start</code> instances. <code>start</code> and <code>end</code> are not 927 * primary keys, they are indexes in the result set. Thus, <code>0</code> 928 * refers to the first result in the set. Setting both <code>start</code> 929 * and <code>end</code> to {@link 930 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 931 * result set. 932 * </p> 933 * 934 * @param repositoryId the primary key of the folder's repository 935 * @param parentFolderId the primary key of the folder's parent folder 936 * @param includeMountFolders whether to include mount folders for 937 third-party repositories 938 * @param start the lower bound of the range of results 939 * @param end the upper bound of the range of results (not inclusive) 940 * @param obc the comparator to order the folders (optionally 941 <code>null</code>) 942 * @return the range of immediate subfolders of the parent folder ordered by 943 comparator <code>obc</code> 944 * @throws PortalException if the parent folder could not be found 945 * @throws SystemException if a system exception occurred 946 */ 947 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 948 long repositoryId, long parentFolderId, boolean includeMountFolders, 949 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 950 throws com.liferay.portal.kernel.exception.PortalException, 951 com.liferay.portal.kernel.exception.SystemException { 952 return _dlAppService.getFolders(repositoryId, parentFolderId, 953 includeMountFolders, start, end, obc); 954 } 955 956 /** 957 * Returns a range of all the immediate subfolders of the parent folder. 958 * 959 * <p> 960 * Useful when paginating results. Returns a maximum of <code>end - 961 * start</code> instances. <code>start</code> and <code>end</code> are not 962 * primary keys, they are indexes in the result set. Thus, <code>0</code> 963 * refers to the first result in the set. Setting both <code>start</code> 964 * and <code>end</code> to {@link 965 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 966 * result set. 967 * </p> 968 * 969 * @param repositoryId the primary key of the folder's repository 970 * @param parentFolderId the primary key of the folder's parent folder 971 * @param start the lower bound of the range of results 972 * @param end the upper bound of the range of results (not inclusive) 973 * @return the range of immediate subfolders of the parent folder 974 * @throws PortalException if the parent folder could not be found 975 * @throws SystemException if a system exception occurred 976 */ 977 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 978 long repositoryId, long parentFolderId, int start, int end) 979 throws com.liferay.portal.kernel.exception.PortalException, 980 com.liferay.portal.kernel.exception.SystemException { 981 return _dlAppService.getFolders(repositoryId, parentFolderId, start, end); 982 } 983 984 /** 985 * Returns an ordered range of all the immediate subfolders of the parent 986 * folder. 987 * 988 * <p> 989 * Useful when paginating results. Returns a maximum of <code>end - 990 * start</code> instances. <code>start</code> and <code>end</code> are not 991 * primary keys, they are indexes in the result set. Thus, <code>0</code> 992 * refers to the first result in the set. Setting both <code>start</code> 993 * and <code>end</code> to {@link 994 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 995 * result set. 996 * </p> 997 * 998 * @param repositoryId the primary key of the folder's repository 999 * @param parentFolderId the primary key of the folder's parent folder 1000 * @param start the lower bound of the range of results 1001 * @param end the upper bound of the range of results (not inclusive) 1002 * @param obc the comparator to order the folders (optionally 1003 <code>null</code>) 1004 * @return the range of immediate subfolders of the parent folder ordered by 1005 comparator <code>obc</code> 1006 * @throws PortalException if the parent folder could not be found 1007 * @throws SystemException if a system exception occurred 1008 */ 1009 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders( 1010 long repositoryId, long parentFolderId, int start, int end, 1011 com.liferay.portal.kernel.util.OrderByComparator obc) 1012 throws com.liferay.portal.kernel.exception.PortalException, 1013 com.liferay.portal.kernel.exception.SystemException { 1014 return _dlAppService.getFolders(repositoryId, parentFolderId, start, 1015 end, obc); 1016 } 1017 1018 /** 1019 * Returns a range of all the immediate subfolders, file entries, and file 1020 * shortcuts in the parent folder. 1021 * 1022 * <p> 1023 * Useful when paginating results. Returns a maximum of <code>end - 1024 * start</code> instances. <code>start</code> and <code>end</code> are not 1025 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1026 * refers to the first result in the set. Setting both <code>start</code> 1027 * and <code>end</code> to {@link 1028 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1029 * result set. 1030 * </p> 1031 * 1032 * @param repositoryId the primary key of the repository 1033 * @param folderId the primary key of the parent folder 1034 * @param status the workflow status 1035 * @param includeMountFolders whether to include mount folders for 1036 third-party repositories 1037 * @param start the lower bound of the range of results 1038 * @param end the upper bound of the range of results (not inclusive) 1039 * @return the range of immediate subfolders, file entries, and file 1040 shortcuts in the parent folder ordered by comparator 1041 <code>obc</code> 1042 * @throws PortalException if the parent folder could not be found 1043 * @throws SystemException if a system exception occurred 1044 */ 1045 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1046 long repositoryId, long folderId, int status, 1047 boolean includeMountFolders, int start, int end) 1048 throws com.liferay.portal.kernel.exception.PortalException, 1049 com.liferay.portal.kernel.exception.SystemException { 1050 return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId, 1051 folderId, status, includeMountFolders, start, end); 1052 } 1053 1054 /** 1055 * Returns an ordered range of all the immediate subfolders, file entries, 1056 * and file shortcuts in the parent folder. 1057 * 1058 * <p> 1059 * Useful when paginating results. Returns a maximum of <code>end - 1060 * start</code> instances. <code>start</code> and <code>end</code> are not 1061 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1062 * refers to the first result in the set. Setting both <code>start</code> 1063 * and <code>end</code> to {@link 1064 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1065 * result set. 1066 * </p> 1067 * 1068 * @param repositoryId the primary key of the repository 1069 * @param folderId the primary key of the parent folder 1070 * @param status the workflow status 1071 * @param includeMountFolders whether to include mount folders for 1072 third-party repositories 1073 * @param start the lower bound of the range of results 1074 * @param end the upper bound of the range of results (not inclusive) 1075 * @param obc the comparator to order the results (optionally 1076 <code>null</code>) 1077 * @return the range of immediate subfolders, file entries, and file 1078 shortcuts in the parent folder ordered by comparator 1079 <code>obc</code> 1080 * @throws PortalException if the parent folder could not be found 1081 * @throws SystemException if a system exception occurred 1082 */ 1083 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1084 long repositoryId, long folderId, int status, 1085 boolean includeMountFolders, int start, int end, 1086 com.liferay.portal.kernel.util.OrderByComparator obc) 1087 throws com.liferay.portal.kernel.exception.PortalException, 1088 com.liferay.portal.kernel.exception.SystemException { 1089 return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId, 1090 folderId, status, includeMountFolders, start, end, obc); 1091 } 1092 1093 public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts( 1094 long repositoryId, long folderId, int status, 1095 java.lang.String[] mimeTypes, boolean includeMountFolders, int start, 1096 int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1097 throws com.liferay.portal.kernel.exception.PortalException, 1098 com.liferay.portal.kernel.exception.SystemException { 1099 return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId, 1100 folderId, status, mimeTypes, includeMountFolders, start, end, obc); 1101 } 1102 1103 /** 1104 * Returns the number of immediate subfolders, file entries, and file 1105 * shortcuts in the parent folder. 1106 * 1107 * @param repositoryId the primary key of the repository 1108 * @param folderId the primary key of the parent folder 1109 * @param status the workflow status 1110 * @param includeMountFolders whether to include mount folders for 1111 third-party repositories 1112 * @return the number of immediate subfolders, file entries, and file 1113 shortcuts in the parent folder 1114 * @throws PortalException if the folder could not be found 1115 * @throws SystemException if a system exception occurred 1116 */ 1117 public int getFoldersAndFileEntriesAndFileShortcutsCount( 1118 long repositoryId, long folderId, int status, 1119 boolean includeMountFolders) 1120 throws com.liferay.portal.kernel.exception.PortalException, 1121 com.liferay.portal.kernel.exception.SystemException { 1122 return _dlAppService.getFoldersAndFileEntriesAndFileShortcutsCount(repositoryId, 1123 folderId, status, includeMountFolders); 1124 } 1125 1126 public int getFoldersAndFileEntriesAndFileShortcutsCount( 1127 long repositoryId, long folderId, int status, 1128 java.lang.String[] mimeTypes, boolean includeMountFolders) 1129 throws com.liferay.portal.kernel.exception.PortalException, 1130 com.liferay.portal.kernel.exception.SystemException { 1131 return _dlAppService.getFoldersAndFileEntriesAndFileShortcutsCount(repositoryId, 1132 folderId, status, mimeTypes, includeMountFolders); 1133 } 1134 1135 /** 1136 * Returns the number of immediate subfolders of the parent folder. 1137 * 1138 * @param repositoryId the primary key of the folder's repository 1139 * @param parentFolderId the primary key of the folder's parent folder 1140 * @return the number of immediate subfolders of the parent folder 1141 * @throws PortalException if the parent folder could not be found 1142 * @throws SystemException if a system exception occurred 1143 */ 1144 public int getFoldersCount(long repositoryId, long parentFolderId) 1145 throws com.liferay.portal.kernel.exception.PortalException, 1146 com.liferay.portal.kernel.exception.SystemException { 1147 return _dlAppService.getFoldersCount(repositoryId, parentFolderId); 1148 } 1149 1150 /** 1151 * Returns the number of immediate subfolders of the parent folder, 1152 * optionally including mount folders for third-party repositories. 1153 * 1154 * @param repositoryId the primary key of the folder's repository 1155 * @param parentFolderId the primary key of the folder's parent folder 1156 * @param includeMountFolders whether to include mount folders for 1157 third-party repositories 1158 * @return the number of immediate subfolders of the parent folder 1159 * @throws PortalException if the parent folder could not be found 1160 * @throws SystemException if a system exception occurred 1161 */ 1162 public int getFoldersCount(long repositoryId, long parentFolderId, 1163 boolean includeMountFolders) 1164 throws com.liferay.portal.kernel.exception.PortalException, 1165 com.liferay.portal.kernel.exception.SystemException { 1166 return _dlAppService.getFoldersCount(repositoryId, parentFolderId, 1167 includeMountFolders); 1168 } 1169 1170 /** 1171 * Returns the number of immediate subfolders and file entries across the 1172 * folders. 1173 * 1174 * @param repositoryId the primary key of the repository 1175 * @param folderIds the primary keys of folders from which to count 1176 immediate subfolders and file entries 1177 * @param status the workflow status 1178 * @return the number of immediate subfolders and file entries across the 1179 folders 1180 * @throws PortalException if the repository could not be found 1181 * @throws SystemException if a system exception occurred 1182 */ 1183 public int getFoldersFileEntriesCount(long repositoryId, 1184 java.util.List<java.lang.Long> folderIds, int status) 1185 throws com.liferay.portal.kernel.exception.PortalException, 1186 com.liferay.portal.kernel.exception.SystemException { 1187 return _dlAppService.getFoldersFileEntriesCount(repositoryId, 1188 folderIds, status); 1189 } 1190 1191 /** 1192 * Returns an ordered range of all the file entries in the group starting at 1193 * the repository default parent folder that are stored within the Liferay 1194 * repository. This method is primarily used to search for recently modified 1195 * file entries. It can be limited to the file entries modified by a given 1196 * user. 1197 * 1198 * <p> 1199 * Useful when paginating results. Returns a maximum of <code>end - 1200 * start</code> instances. <code>start</code> and <code>end</code> are not 1201 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1202 * refers to the first result in the set. Setting both <code>start</code> 1203 * and <code>end</code> to {@link 1204 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1205 * result set. 1206 * </p> 1207 * 1208 * @param groupId the primary key of the group 1209 * @param userId the primary key of the user who created the file 1210 (optionally <code>0</code>) 1211 * @param start the lower bound of the range of results 1212 * @param end the upper bound of the range of results (not inclusive) 1213 * @return the range of matching file entries ordered by date modified 1214 * @throws PortalException if the group could not be found 1215 * @throws SystemException if a system exception occurred 1216 */ 1217 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1218 long groupId, long userId, int start, int end) 1219 throws com.liferay.portal.kernel.exception.PortalException, 1220 com.liferay.portal.kernel.exception.SystemException { 1221 return _dlAppService.getGroupFileEntries(groupId, userId, start, end); 1222 } 1223 1224 /** 1225 * Returns an ordered range of all the file entries in the group that are 1226 * stored within the Liferay repository. This method is primarily used to 1227 * search for recently modified file entries. It can be limited to the file 1228 * entries modified by a given user. 1229 * 1230 * <p> 1231 * Useful when paginating results. Returns a maximum of <code>end - 1232 * start</code> instances. <code>start</code> and <code>end</code> are not 1233 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1234 * refers to the first result in the set. Setting both <code>start</code> 1235 * and <code>end</code> to {@link 1236 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1237 * result set. 1238 * </p> 1239 * 1240 * @param groupId the primary key of the group 1241 * @param userId the primary key of the user who created the file 1242 (optionally <code>0</code>) 1243 * @param start the lower bound of the range of results 1244 * @param end the upper bound of the range of results (not inclusive) 1245 * @param obc the comparator to order the file entries (optionally 1246 <code>null</code>) 1247 * @return the range of matching file entries ordered by comparator 1248 <code>obc</code> 1249 * @throws PortalException if the group could not be found 1250 * @throws SystemException if a system exception occurred 1251 */ 1252 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1253 long groupId, long userId, int start, int end, 1254 com.liferay.portal.kernel.util.OrderByComparator obc) 1255 throws com.liferay.portal.kernel.exception.PortalException, 1256 com.liferay.portal.kernel.exception.SystemException { 1257 return _dlAppService.getGroupFileEntries(groupId, userId, start, end, 1258 obc); 1259 } 1260 1261 /** 1262 * Returns an ordered range of all the file entries in the group starting at 1263 * the root folder that are stored within the Liferay repository. This 1264 * method is primarily used to search for recently modified file entries. It 1265 * can be limited to the file entries modified by a given user. 1266 * 1267 * <p> 1268 * Useful when paginating results. Returns a maximum of <code>end - 1269 * start</code> instances. <code>start</code> and <code>end</code> are not 1270 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1271 * refers to the first result in the set. Setting both <code>start</code> 1272 * and <code>end</code> to {@link 1273 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1274 * result set. 1275 * </p> 1276 * 1277 * @param groupId the primary key of the group 1278 * @param userId the primary key of the user who created the file 1279 (optionally <code>0</code>) 1280 * @param rootFolderId the primary key of the root folder to begin the 1281 search 1282 * @param start the lower bound of the range of results 1283 * @param end the upper bound of the range of results (not inclusive) 1284 * @return the range of matching file entries ordered by date modified 1285 * @throws PortalException if the group could not be found 1286 * @throws SystemException if a system exception occurred 1287 */ 1288 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1289 long groupId, long userId, long rootFolderId, int start, int end) 1290 throws com.liferay.portal.kernel.exception.PortalException, 1291 com.liferay.portal.kernel.exception.SystemException { 1292 return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId, 1293 start, end); 1294 } 1295 1296 /** 1297 * Returns an ordered range of all the file entries in the group starting at 1298 * the root folder that are stored within the Liferay repository. This 1299 * method is primarily used to search for recently modified file entries. It 1300 * can be limited to the file entries modified by a given user. 1301 * 1302 * <p> 1303 * Useful when paginating results. Returns a maximum of <code>end - 1304 * start</code> instances. <code>start</code> and <code>end</code> are not 1305 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1306 * refers to the first result in the set. Setting both <code>start</code> 1307 * and <code>end</code> to {@link 1308 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1309 * result set. 1310 * </p> 1311 * 1312 * @param groupId the primary key of the group 1313 * @param userId the primary key of the user who created the file 1314 (optionally <code>0</code>) 1315 * @param rootFolderId the primary key of the root folder to begin the 1316 search 1317 * @param start the lower bound of the range of results 1318 * @param end the upper bound of the range of results (not inclusive) 1319 * @param obc the comparator to order the file entries (optionally 1320 <code>null</code>) 1321 * @return the range of matching file entries ordered by comparator 1322 <code>obc</code> 1323 * @throws PortalException if the group could not be found 1324 * @throws SystemException if a system exception occurred 1325 */ 1326 public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries( 1327 long groupId, long userId, long rootFolderId, int start, int end, 1328 com.liferay.portal.kernel.util.OrderByComparator obc) 1329 throws com.liferay.portal.kernel.exception.PortalException, 1330 com.liferay.portal.kernel.exception.SystemException { 1331 return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId, 1332 start, end, obc); 1333 } 1334 1335 /** 1336 * Returns the number of file entries in a group starting at the repository 1337 * default parent folder that are stored within the Liferay repository. This 1338 * method is primarily used to search for recently modified file entries. It 1339 * can be limited to the file entries modified by a given user. 1340 * 1341 * @param groupId the primary key of the group 1342 * @param userId the primary key of the user who created the file 1343 (optionally <code>0</code>) 1344 * @return the number of matching file entries 1345 * @throws PortalException if the group could not be found 1346 * @throws SystemException if a system exception occurred 1347 */ 1348 public int getGroupFileEntriesCount(long groupId, long userId) 1349 throws com.liferay.portal.kernel.exception.PortalException, 1350 com.liferay.portal.kernel.exception.SystemException { 1351 return _dlAppService.getGroupFileEntriesCount(groupId, userId); 1352 } 1353 1354 /** 1355 * Returns the number of file entries in a group starting at the root folder 1356 * that are stored within the Liferay repository. This method is primarily 1357 * used to search for recently modified file entries. It can be limited to 1358 * the file entries modified by a given user. 1359 * 1360 * @param groupId the primary key of the group 1361 * @param userId the primary key of the user who created the file 1362 (optionally <code>0</code>) 1363 * @param rootFolderId the primary key of the root folder to begin the 1364 search 1365 * @return the number of matching file entries 1366 * @throws PortalException if the group could not be found 1367 * @throws SystemException if a system exception occurred 1368 */ 1369 public int getGroupFileEntriesCount(long groupId, long userId, 1370 long rootFolderId) 1371 throws com.liferay.portal.kernel.exception.PortalException, 1372 com.liferay.portal.kernel.exception.SystemException { 1373 return _dlAppService.getGroupFileEntriesCount(groupId, userId, 1374 rootFolderId); 1375 } 1376 1377 /** 1378 * Returns all immediate subfolders of the parent folder that are used for 1379 * mounting third-party repositories. This method is only supported by the 1380 * Liferay repository. 1381 * 1382 * @param repositoryId the primary key of the folder's repository 1383 * @param parentFolderId the primary key of the folder's parent folder 1384 * @return the immediate subfolders of the parent folder that are used for 1385 mounting third-party repositories 1386 * @throws PortalException if the repository or parent folder could not be 1387 found 1388 * @throws SystemException if a system exception occurred 1389 */ 1390 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1391 long repositoryId, long parentFolderId) 1392 throws com.liferay.portal.kernel.exception.PortalException, 1393 com.liferay.portal.kernel.exception.SystemException { 1394 return _dlAppService.getMountFolders(repositoryId, parentFolderId); 1395 } 1396 1397 /** 1398 * Returns a range of all the immediate subfolders of the parent folder that 1399 * are used for mounting third-party repositories. This method is only 1400 * supported by the Liferay repository. 1401 * 1402 * <p> 1403 * Useful when paginating results. Returns a maximum of <code>end - 1404 * start</code> instances. <code>start</code> and <code>end</code> are not 1405 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1406 * refers to the first result in the set. Setting both <code>start</code> 1407 * and <code>end</code> to {@link 1408 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1409 * result set. 1410 * </p> 1411 * 1412 * @param repositoryId the primary key of the repository 1413 * @param parentFolderId the primary key of the parent folder 1414 * @param start the lower bound of the range of results 1415 * @param end the upper bound of the range of results (not inclusive) 1416 * @return the range of immediate subfolders of the parent folder that are 1417 used for mounting third-party repositories 1418 * @throws PortalException if the repository or parent folder could not be 1419 found 1420 * @throws SystemException if a system exception occurred 1421 */ 1422 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1423 long repositoryId, long parentFolderId, int start, int end) 1424 throws com.liferay.portal.kernel.exception.PortalException, 1425 com.liferay.portal.kernel.exception.SystemException { 1426 return _dlAppService.getMountFolders(repositoryId, parentFolderId, 1427 start, end); 1428 } 1429 1430 /** 1431 * Returns an ordered range of all the immediate subfolders of the parent 1432 * folder that are used for mounting third-party repositories. This method 1433 * is only supported by the Liferay repository. 1434 * 1435 * <p> 1436 * Useful when paginating results. Returns a maximum of <code>end - 1437 * start</code> instances. <code>start</code> and <code>end</code> are not 1438 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1439 * refers to the first result in the set. Setting both <code>start</code> 1440 * and <code>end</code> to {@link 1441 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1442 * result set. 1443 * </p> 1444 * 1445 * @param repositoryId the primary key of the folder's repository 1446 * @param parentFolderId the primary key of the folder's parent folder 1447 * @param start the lower bound of the range of results 1448 * @param end the upper bound of the range of results (not inclusive) 1449 * @param obc the comparator to order the folders (optionally 1450 <code>null</code>) 1451 * @return the range of immediate subfolders of the parent folder that are 1452 used for mounting third-party repositories ordered by comparator 1453 <code>obc</code> 1454 * @throws PortalException if the repository or parent folder could not be 1455 found 1456 * @throws SystemException if a system exception occurred 1457 */ 1458 public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders( 1459 long repositoryId, long parentFolderId, int start, int end, 1460 com.liferay.portal.kernel.util.OrderByComparator obc) 1461 throws com.liferay.portal.kernel.exception.PortalException, 1462 com.liferay.portal.kernel.exception.SystemException { 1463 return _dlAppService.getMountFolders(repositoryId, parentFolderId, 1464 start, end, obc); 1465 } 1466 1467 public void getSubfolderIds(long repositoryId, 1468 java.util.List<java.lang.Long> folderIds, long folderId) 1469 throws com.liferay.portal.kernel.exception.PortalException, 1470 com.liferay.portal.kernel.exception.SystemException { 1471 _dlAppService.getSubfolderIds(repositoryId, folderIds, folderId); 1472 } 1473 1474 /** 1475 * Returns all the descendant folders of the folder with the primary key. 1476 * 1477 * @param repositoryId the primary key of the repository 1478 * @param folderId the primary key of the folder 1479 * @return the descendant folders of the folder with the primary key 1480 * @throws PortalException if the repository or parent folder could not be 1481 found 1482 * @throws SystemException if a system exception occurred 1483 */ 1484 public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId, 1485 long folderId) 1486 throws com.liferay.portal.kernel.exception.PortalException, 1487 com.liferay.portal.kernel.exception.SystemException { 1488 return _dlAppService.getSubfolderIds(repositoryId, folderId); 1489 } 1490 1491 /** 1492 * Returns descendant folders of the folder with the primary key, optionally 1493 * limiting to one level deep. 1494 * 1495 * @param repositoryId the primary key of the repository 1496 * @param folderId the primary key of the folder 1497 * @param recurse whether to recurse through each subfolder 1498 * @return the descendant folders of the folder with the primary key 1499 * @throws PortalException if the repository or parent folder could not be 1500 found 1501 * @throws SystemException if a system exception occurred 1502 */ 1503 public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId, 1504 long folderId, boolean recurse) 1505 throws com.liferay.portal.kernel.exception.PortalException, 1506 com.liferay.portal.kernel.exception.SystemException { 1507 return _dlAppService.getSubfolderIds(repositoryId, folderId, recurse); 1508 } 1509 1510 /** 1511 * Returns all the temporary file entry names. 1512 * 1513 * @param groupId the primary key of the group 1514 * @param folderId the primary key of the folder where the file entry will 1515 eventually reside 1516 * @param tempFolderName the temporary folder's name 1517 * @return the temporary file entry names 1518 * @throws PortalException if the folder was invalid 1519 * @throws SystemException if a system exception occurred 1520 * @see #addTempFileEntry(long, long, String, String, File) 1521 * @see com.liferay.portal.kernel.util.TempFileUtil 1522 */ 1523 public java.lang.String[] getTempFileEntryNames(long groupId, 1524 long folderId, java.lang.String tempFolderName) 1525 throws com.liferay.portal.kernel.exception.PortalException, 1526 com.liferay.portal.kernel.exception.SystemException { 1527 return _dlAppService.getTempFileEntryNames(groupId, folderId, 1528 tempFolderName); 1529 } 1530 1531 /** 1532 * Locks the folder. This method is primarily used by WebDAV. 1533 * 1534 * @param repositoryId the primary key of the repository 1535 * @param folderId the primary key of the folder 1536 * @return the lock object 1537 * @throws PortalException if the repository or folder could not be found 1538 * @throws SystemException if a system exception occurred 1539 */ 1540 public com.liferay.portal.model.Lock lockFolder(long repositoryId, 1541 long folderId) 1542 throws com.liferay.portal.kernel.exception.PortalException, 1543 com.liferay.portal.kernel.exception.SystemException { 1544 return _dlAppService.lockFolder(repositoryId, folderId); 1545 } 1546 1547 /** 1548 * Locks the folder. This method is primarily used by WebDAV. 1549 * 1550 * @param repositoryId the primary key of the repository 1551 * @param folderId the primary key of the folder 1552 * @param owner the owner string for the checkout (optionally 1553 <code>null</code>) 1554 * @param inheritable whether the lock must propagate to descendants 1555 * @param expirationTime the time in milliseconds before the lock expires. 1556 If the value is <code>0</code>, the default expiration time will 1557 be used from <code>portal.properties>. 1558 * @return the lock object 1559 * @throws PortalException if the repository or folder could not be found 1560 * @throws SystemException if a system exception occurred 1561 */ 1562 public com.liferay.portal.model.Lock lockFolder(long repositoryId, 1563 long folderId, java.lang.String owner, boolean inheritable, 1564 long expirationTime) 1565 throws com.liferay.portal.kernel.exception.PortalException, 1566 com.liferay.portal.kernel.exception.SystemException { 1567 return _dlAppService.lockFolder(repositoryId, folderId, owner, 1568 inheritable, expirationTime); 1569 } 1570 1571 /** 1572 * Moves the file entry to the new folder. 1573 * 1574 * @param fileEntryId the primary key of the file entry 1575 * @param newFolderId the primary key of the new folder 1576 * @param serviceContext the service context to be applied 1577 * @return the file entry 1578 * @throws PortalException if the file entry or the new folder could not be 1579 found 1580 * @throws SystemException if a system exception occurred 1581 */ 1582 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry( 1583 long fileEntryId, long newFolderId, 1584 com.liferay.portal.service.ServiceContext serviceContext) 1585 throws com.liferay.portal.kernel.exception.PortalException, 1586 com.liferay.portal.kernel.exception.SystemException { 1587 return _dlAppService.moveFileEntry(fileEntryId, newFolderId, 1588 serviceContext); 1589 } 1590 1591 /** 1592 * Moves the folder to the new parent folder with the primary key. 1593 * 1594 * @param folderId the primary key of the folder 1595 * @param parentFolderId the primary key of the new parent folder 1596 * @param serviceContext the service context to be applied 1597 * @return the file entry 1598 * @throws PortalException if the folder could not be found 1599 * @throws SystemException if a system exception occurred 1600 */ 1601 public com.liferay.portal.kernel.repository.model.Folder moveFolder( 1602 long folderId, long parentFolderId, 1603 com.liferay.portal.service.ServiceContext serviceContext) 1604 throws com.liferay.portal.kernel.exception.PortalException, 1605 com.liferay.portal.kernel.exception.SystemException { 1606 return _dlAppService.moveFolder(folderId, parentFolderId, serviceContext); 1607 } 1608 1609 /** 1610 * Refreshes the lock for the file entry. This method is primarily used by 1611 * WebDAV. 1612 * 1613 * @param lockUuid the lock's universally unique identifier 1614 * @param expirationTime the time in milliseconds before the lock expires. 1615 If the value is <code>0</code>, the default expiration time will 1616 be used from <code>portal.properties>. 1617 * @return the lock object 1618 * @throws PortalException if the file entry or lock could not be found 1619 * @throws SystemException if a system exception occurred 1620 */ 1621 public com.liferay.portal.model.Lock refreshFileEntryLock( 1622 java.lang.String lockUuid, long expirationTime) 1623 throws com.liferay.portal.kernel.exception.PortalException, 1624 com.liferay.portal.kernel.exception.SystemException { 1625 return _dlAppService.refreshFileEntryLock(lockUuid, expirationTime); 1626 } 1627 1628 /** 1629 * Refreshes the lock for the folder. This method is primarily used by 1630 * WebDAV. 1631 * 1632 * @param lockUuid the lock's universally unique identifier 1633 * @param expirationTime the time in milliseconds before the lock expires. 1634 If the value is <code>0</code>, the default expiration time will 1635 be used from <code>portal.properties>. 1636 * @return the lock object 1637 * @throws PortalException if the folder or lock could not be found 1638 * @throws SystemException if a system exception occurred 1639 */ 1640 public com.liferay.portal.model.Lock refreshFolderLock( 1641 java.lang.String lockUuid, long expirationTime) 1642 throws com.liferay.portal.kernel.exception.PortalException, 1643 com.liferay.portal.kernel.exception.SystemException { 1644 return _dlAppService.refreshFolderLock(lockUuid, expirationTime); 1645 } 1646 1647 /** 1648 * Reverts the file entry to a previous version. A new version will be 1649 * created based on the previous version and metadata. 1650 * 1651 * @param fileEntryId the primary key of the file entry 1652 * @param version the version to revert back to 1653 * @param serviceContext the service context to be applied 1654 * @throws PortalException if the file entry or version could not be found 1655 * @throws SystemException if a system exception occurred 1656 */ 1657 public void revertFileEntry(long fileEntryId, java.lang.String version, 1658 com.liferay.portal.service.ServiceContext serviceContext) 1659 throws com.liferay.portal.kernel.exception.PortalException, 1660 com.liferay.portal.kernel.exception.SystemException { 1661 _dlAppService.revertFileEntry(fileEntryId, version, serviceContext); 1662 } 1663 1664 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 1665 com.liferay.portal.kernel.search.SearchContext searchContext) 1666 throws com.liferay.portal.kernel.search.SearchException { 1667 return _dlAppService.search(repositoryId, searchContext); 1668 } 1669 1670 public com.liferay.portal.kernel.search.Hits search(long repositoryId, 1671 com.liferay.portal.kernel.search.SearchContext searchContext, 1672 com.liferay.portal.kernel.search.Query query) 1673 throws com.liferay.portal.kernel.search.SearchException { 1674 return _dlAppService.search(repositoryId, searchContext, query); 1675 } 1676 1677 /** 1678 * Unlocks the folder. This method is primarily used by WebDAV. 1679 * 1680 * @param repositoryId the primary key of the repository 1681 * @param folderId the primary key of the folder 1682 * @param lockUuid the lock's universally unique identifier 1683 * @throws PortalException if the repository or folder could not be found 1684 * @throws SystemException if a system exception occurred 1685 */ 1686 public void unlockFolder(long repositoryId, long folderId, 1687 java.lang.String lockUuid) 1688 throws com.liferay.portal.kernel.exception.PortalException, 1689 com.liferay.portal.kernel.exception.SystemException { 1690 _dlAppService.unlockFolder(repositoryId, folderId, lockUuid); 1691 } 1692 1693 /** 1694 * Unlocks the folder. This method is primarily used by WebDAV. 1695 * 1696 * @param repositoryId the primary key of the repository 1697 * @param parentFolderId the primary key of the parent folder 1698 * @param name the folder's name 1699 * @param lockUuid the lock's universally unique identifier 1700 * @throws PortalException if the repository or folder could not be found 1701 * @throws SystemException if a system exception occurred 1702 */ 1703 public void unlockFolder(long repositoryId, long parentFolderId, 1704 java.lang.String name, java.lang.String lockUuid) 1705 throws com.liferay.portal.kernel.exception.PortalException, 1706 com.liferay.portal.kernel.exception.SystemException { 1707 _dlAppService.unlockFolder(repositoryId, parentFolderId, name, lockUuid); 1708 } 1709 1710 /** 1711 * Updates a file entry and associated metadata based on a byte array 1712 * object. If the file data is <code>null</code>, then only the associated 1713 * metadata (i.e., <code>title</code>, <code>description</code>, and 1714 * parameters in the <code>serviceContext</code>) will be updated. 1715 * 1716 * <p> 1717 * This method takes two file names, the <code>sourceFileName</code> and the 1718 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 1719 * name of the actual file being uploaded. The <code>title</code> 1720 * corresponds to a name the client wishes to assign this file after it has 1721 * been uploaded to the portal. 1722 * </p> 1723 * 1724 * @param fileEntryId the primary key of the file entry 1725 * @param sourceFileName the original file's name (optionally 1726 <code>null</code>) 1727 * @param mimeType the file's MIME type (optionally <code>null</code>) 1728 * @param title the new name to be assigned to the file (optionally <code> 1729 <code>null</code></code>) 1730 * @param description the file's new description 1731 * @param changeLog the file's version change log (optionally 1732 <code>null</code>) 1733 * @param majorVersion whether the new file version is a major version 1734 * @param bytes the file's data (optionally <code>null</code>) 1735 * @param serviceContext the service context to be applied. Can set the 1736 asset category IDs, asset tag names, and expando bridge 1737 attributes for the file entry. In a Liferay repository, it may 1738 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 1739 type </li> <li> fieldsMap - mapping for fields associated with a 1740 custom file entry type </li> </ul> 1741 * @return the file entry 1742 * @throws PortalException if the file entry could not be found 1743 * @throws SystemException if a system exception occurred 1744 */ 1745 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 1746 long fileEntryId, java.lang.String sourceFileName, 1747 java.lang.String mimeType, java.lang.String title, 1748 java.lang.String description, java.lang.String changeLog, 1749 boolean majorVersion, byte[] bytes, 1750 com.liferay.portal.service.ServiceContext serviceContext) 1751 throws com.liferay.portal.kernel.exception.PortalException, 1752 com.liferay.portal.kernel.exception.SystemException { 1753 return _dlAppService.updateFileEntry(fileEntryId, sourceFileName, 1754 mimeType, title, description, changeLog, majorVersion, bytes, 1755 serviceContext); 1756 } 1757 1758 /** 1759 * Updates a file entry and associated metadata based on a {@link File} 1760 * object. If the file data is <code>null</code>, then only the associated 1761 * metadata (i.e., <code>title</code>, <code>description</code>, and 1762 * parameters in the <code>serviceContext</code>) will be updated. 1763 * 1764 * <p> 1765 * This method takes two file names, the <code>sourceFileName</code> and the 1766 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 1767 * name of the actual file being uploaded. The <code>title</code> 1768 * corresponds to a name the client wishes to assign this file after it has 1769 * been uploaded to the portal. 1770 * </p> 1771 * 1772 * @param fileEntryId the primary key of the file entry 1773 * @param sourceFileName the original file's name (optionally 1774 <code>null</code>) 1775 * @param mimeType the file's MIME type (optionally <code>null</code>) 1776 * @param title the new name to be assigned to the file (optionally <code> 1777 <code>null</code></code>) 1778 * @param description the file's new description 1779 * @param changeLog the file's version change log (optionally 1780 <code>null</code>) 1781 * @param majorVersion whether the new file version is a major version 1782 * @param file EntryId the primary key of the file entry 1783 * @param serviceContext the service context to be applied. Can set the 1784 asset category IDs, asset tag names, and expando bridge 1785 attributes for the file entry. In a Liferay repository, it may 1786 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 1787 type </li> <li> fieldsMap - mapping for fields associated with a 1788 custom file entry type </li> </ul> 1789 * @return the file entry 1790 * @throws PortalException if the file entry could not be found 1791 * @throws SystemException if a system exception occurred 1792 */ 1793 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 1794 long fileEntryId, java.lang.String sourceFileName, 1795 java.lang.String mimeType, java.lang.String title, 1796 java.lang.String description, java.lang.String changeLog, 1797 boolean majorVersion, java.io.File file, 1798 com.liferay.portal.service.ServiceContext serviceContext) 1799 throws com.liferay.portal.kernel.exception.PortalException, 1800 com.liferay.portal.kernel.exception.SystemException { 1801 return _dlAppService.updateFileEntry(fileEntryId, sourceFileName, 1802 mimeType, title, description, changeLog, majorVersion, file, 1803 serviceContext); 1804 } 1805 1806 /** 1807 * Updates a file entry and associated metadata based on an {@link 1808 * InputStream} object. If the file data is <code>null</code>, then only the 1809 * associated metadata (i.e., <code>title</code>, <code>description</code>, 1810 * and parameters in the <code>serviceContext</code>) will be updated. 1811 * 1812 * <p> 1813 * This method takes two file names, the <code>sourceFileName</code> and the 1814 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 1815 * name of the actual file being uploaded. The <code>title</code> 1816 * corresponds to a name the client wishes to assign this file after it has 1817 * been uploaded to the portal. 1818 * </p> 1819 * 1820 * @param fileEntryId the primary key of the file entry 1821 * @param sourceFileName the original file's name (optionally 1822 <code>null</code>) 1823 * @param mimeType the file's MIME type (optionally <code>null</code>) 1824 * @param title the new name to be assigned to the file (optionally <code> 1825 <code>null</code></code>) 1826 * @param description the file's new description 1827 * @param changeLog the file's version change log (optionally 1828 <code>null</code>) 1829 * @param majorVersion whether the new file version is a major version 1830 * @param is the file's data (optionally <code>null</code>) 1831 * @param size the file's size (optionally <code>0</code>) 1832 * @param serviceContext the service context to be applied. Can set the 1833 asset category IDs, asset tag names, and expando bridge 1834 attributes for the file entry. In a Liferay repository, it may 1835 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 1836 type </li> <li> fieldsMap - mapping for fields associated with a 1837 custom file entry type </li> </ul> 1838 * @return the file entry 1839 * @throws PortalException if the file entry could not be found 1840 * @throws SystemException if a system exception occurred 1841 */ 1842 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 1843 long fileEntryId, java.lang.String sourceFileName, 1844 java.lang.String mimeType, java.lang.String title, 1845 java.lang.String description, java.lang.String changeLog, 1846 boolean majorVersion, java.io.InputStream is, long size, 1847 com.liferay.portal.service.ServiceContext serviceContext) 1848 throws com.liferay.portal.kernel.exception.PortalException, 1849 com.liferay.portal.kernel.exception.SystemException { 1850 return _dlAppService.updateFileEntry(fileEntryId, sourceFileName, 1851 mimeType, title, description, changeLog, majorVersion, is, size, 1852 serviceContext); 1853 } 1854 1855 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn( 1856 long fileEntryId, java.lang.String sourceFileName, 1857 java.lang.String mimeType, java.lang.String title, 1858 java.lang.String description, java.lang.String changeLog, 1859 boolean majorVersion, java.io.File file, 1860 com.liferay.portal.service.ServiceContext serviceContext) 1861 throws com.liferay.portal.kernel.exception.PortalException, 1862 com.liferay.portal.kernel.exception.SystemException { 1863 return _dlAppService.updateFileEntryAndCheckIn(fileEntryId, 1864 sourceFileName, mimeType, title, description, changeLog, 1865 majorVersion, file, serviceContext); 1866 } 1867 1868 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn( 1869 long fileEntryId, java.lang.String sourceFileName, 1870 java.lang.String mimeType, java.lang.String title, 1871 java.lang.String description, java.lang.String changeLog, 1872 boolean majorVersion, java.io.InputStream is, long size, 1873 com.liferay.portal.service.ServiceContext serviceContext) 1874 throws com.liferay.portal.kernel.exception.PortalException, 1875 com.liferay.portal.kernel.exception.SystemException { 1876 return _dlAppService.updateFileEntryAndCheckIn(fileEntryId, 1877 sourceFileName, mimeType, title, description, changeLog, 1878 majorVersion, is, size, serviceContext); 1879 } 1880 1881 /** 1882 * Updates a file shortcut to the existing file entry. This method is only 1883 * supported by the Liferay repository. 1884 * 1885 * @param fileShortcutId the primary key of the file shortcut 1886 * @param folderId the primary key of the file shortcut's parent folder 1887 * @param toFileEntryId the primary key of the file shortcut's file entry 1888 * @param serviceContext the service context to be applied. Can set the 1889 asset category IDs, asset tag names, and expando bridge 1890 attributes for the file entry. 1891 * @return the file shortcut 1892 * @throws PortalException if the file shortcut, folder, or file entry could 1893 not be found 1894 * @throws SystemException if a system exception occurred 1895 */ 1896 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 1897 long fileShortcutId, long folderId, long toFileEntryId, 1898 com.liferay.portal.service.ServiceContext serviceContext) 1899 throws com.liferay.portal.kernel.exception.PortalException, 1900 com.liferay.portal.kernel.exception.SystemException { 1901 return _dlAppService.updateFileShortcut(fileShortcutId, folderId, 1902 toFileEntryId, serviceContext); 1903 } 1904 1905 /** 1906 * Updates the folder. 1907 * 1908 * @param folderId the primary key of the folder 1909 * @param name the folder's new name 1910 * @param description the folder's new description 1911 * @param serviceContext the service context to be applied. In a Liferay 1912 repository, it may include: <ul> <li> defaultFileEntryTypeId - 1913 the file entry type to default all Liferay file entries to </li> 1914 <li> fileEntryTypeSearchContainerPrimaryKeys - a comma-delimited 1915 list of file entry type primary keys allowed in the given folder 1916 and all descendants </li> <li> overrideFileEntryTypes - boolean 1917 specifying whether to override ancestral folder's restriction of 1918 file entry types allowed </li> <li> workflowDefinitionXYZ - the 1919 workflow definition name specified per file entry type. The 1920 parameter name must be the string <code>workflowDefinition</code> 1921 appended by the <code>fileEntryTypeId</code> (optionally 1922 <code>0</code>). </li> </ul> 1923 * @return the folder 1924 * @throws PortalException if the current or new parent folder could not be 1925 found or if the new parent folder's information was invalid 1926 * @throws SystemException if a system exception occurred 1927 */ 1928 public com.liferay.portal.kernel.repository.model.Folder updateFolder( 1929 long folderId, java.lang.String name, java.lang.String description, 1930 com.liferay.portal.service.ServiceContext serviceContext) 1931 throws com.liferay.portal.kernel.exception.PortalException, 1932 com.liferay.portal.kernel.exception.SystemException { 1933 return _dlAppService.updateFolder(folderId, name, description, 1934 serviceContext); 1935 } 1936 1937 /** 1938 * Returns <code>true</code> if the file entry is checked out. This method 1939 * is primarily used by WebDAV. 1940 * 1941 * @param repositoryId the primary key for the repository 1942 * @param fileEntryId the primary key for the file entry 1943 * @param lockUuid the lock's universally unique identifier 1944 * @return <code>true</code> if the file entry is checked out; 1945 <code>false</code> otherwise 1946 * @throws PortalException if the file entry could not be found 1947 * @throws SystemException if a system exception occurred 1948 */ 1949 public boolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId, 1950 java.lang.String lockUuid) 1951 throws com.liferay.portal.kernel.exception.PortalException, 1952 com.liferay.portal.kernel.exception.SystemException { 1953 return _dlAppService.verifyFileEntryCheckOut(repositoryId, fileEntryId, 1954 lockUuid); 1955 } 1956 1957 /** 1958 * Returns <code>true</code> if the inheritable lock exists. This method is 1959 * primarily used by WebDAV. 1960 * 1961 * @param repositoryId the primary key for the repository 1962 * @param folderId the primary key for the folder 1963 * @param lockUuid the lock's universally unique identifier 1964 * @return <code>true</code> if the inheritable lock exists; 1965 <code>false</code> otherwise 1966 * @throws PortalException if the folder could not be found 1967 * @throws SystemException if a system exception occurred 1968 */ 1969 public boolean verifyInheritableLock(long repositoryId, long folderId, 1970 java.lang.String lockUuid) 1971 throws com.liferay.portal.kernel.exception.PortalException, 1972 com.liferay.portal.kernel.exception.SystemException { 1973 return _dlAppService.verifyInheritableLock(repositoryId, folderId, 1974 lockUuid); 1975 } 1976 1977 /** 1978 * @deprecated Renamed to {@link #getWrappedService} 1979 */ 1980 public DLAppService getWrappedDLAppService() { 1981 return _dlAppService; 1982 } 1983 1984 /** 1985 * @deprecated Renamed to {@link #setWrappedService} 1986 */ 1987 public void setWrappedDLAppService(DLAppService dlAppService) { 1988 _dlAppService = dlAppService; 1989 } 1990 1991 public DLAppService getWrappedService() { 1992 return _dlAppService; 1993 } 1994 1995 public void setWrappedService(DLAppService dlAppService) { 1996 _dlAppService = dlAppService; 1997 } 1998 1999 private DLAppService _dlAppService; 2000 }