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