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