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