001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.documentlibrary.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.service.ServiceWrapper; 020 021 /** 022 * Provides a wrapper for {@link DLAppLocalService}. 023 * 024 * @author Brian Wing Shun Chan 025 * @see DLAppLocalService 026 * @generated 027 */ 028 @ProviderType 029 public class DLAppLocalServiceWrapper implements DLAppLocalService, 030 ServiceWrapper<DLAppLocalService> { 031 public DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService) { 032 _dlAppLocalService = dlAppLocalService; 033 } 034 035 /** 036 * Returns the Spring bean ID for this bean. 037 * 038 * @return the Spring bean ID for this bean 039 */ 040 @Override 041 public java.lang.String getBeanIdentifier() { 042 return _dlAppLocalService.getBeanIdentifier(); 043 } 044 045 /** 046 * Sets the Spring bean ID for this bean. 047 * 048 * @param beanIdentifier the Spring bean ID for this bean 049 */ 050 @Override 051 public void setBeanIdentifier(java.lang.String beanIdentifier) { 052 _dlAppLocalService.setBeanIdentifier(beanIdentifier); 053 } 054 055 /** 056 * Adds a file entry and associated metadata based on a byte array. 057 * 058 * <p> 059 * This method takes two file names, the <code>sourceFileName</code> and the 060 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 061 * name of the actual file being uploaded. The <code>title</code> 062 * corresponds to a name the client wishes to assign this file after it has 063 * been uploaded to the portal. If it is <code>null</code>, the <code> 064 * sourceFileName</code> will be used. 065 * </p> 066 * 067 * @param userId the primary key of the file entry's creator/owner 068 * @param repositoryId the primary key of the file entry's repository 069 * @param folderId the primary key of the file entry's parent folder 070 * @param sourceFileName the original file's name 071 * @param mimeType the file's MIME type 072 * @param title the name to be assigned to the file (optionally <code>null 073 </code>) 074 * @param description the file's description 075 * @param changeLog the file's version change log 076 * @param bytes the file's data (optionally <code>null</code>) 077 * @param serviceContext the service context to be applied. Can set the 078 asset category IDs, asset tag names, and expando bridge 079 attributes for the file entry. In a Liferay repository, it may 080 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 081 type </li> <li> fieldsMap - mapping for fields associated with a 082 custom file entry type </li> </ul> 083 * @return the file entry 084 * @throws PortalException if the parent folder could not be found or if the 085 file entry's information was invalid 086 * @throws SystemException if a system exception occurred 087 */ 088 @Override 089 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 090 long userId, long repositoryId, long folderId, 091 java.lang.String sourceFileName, java.lang.String mimeType, 092 java.lang.String title, java.lang.String description, 093 java.lang.String changeLog, byte[] bytes, 094 com.liferay.portal.service.ServiceContext serviceContext) 095 throws com.liferay.portal.kernel.exception.PortalException, 096 com.liferay.portal.kernel.exception.SystemException { 097 return _dlAppLocalService.addFileEntry(userId, repositoryId, folderId, 098 sourceFileName, mimeType, title, description, changeLog, bytes, 099 serviceContext); 100 } 101 102 /** 103 * Adds a file entry and associated metadata based on a {@link java.io.File} 104 * object. 105 * 106 * <p> 107 * This method takes two file names, the <code>sourceFileName</code> and the 108 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 109 * name of the actual file being uploaded. The <code>title</code> 110 * corresponds to a name the client wishes to assign this file after it has 111 * been uploaded to the portal. If it is <code>null</code>, the <code> 112 * sourceFileName</code> will be used. 113 * </p> 114 * 115 * @param userId the primary key of the file entry's creator/owner 116 * @param repositoryId the primary key of the repository 117 * @param folderId the primary key of the file entry's parent folder 118 * @param sourceFileName the original file's name 119 * @param mimeType the file's MIME type 120 * @param title the name to be assigned to the file (optionally <code>null 121 </code>) 122 * @param description the file's description 123 * @param changeLog the file's version change log 124 * @param file the file's data (optionally <code>null</code>) 125 * @param serviceContext the service context to be applied. Can set the 126 asset category IDs, asset tag names, and expando bridge 127 attributes for the file entry. In a Liferay repository, it may 128 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 129 type </li> <li> fieldsMap - mapping for fields associated with a 130 custom file entry type </li> </ul> 131 * @return the file entry 132 * @throws PortalException if the parent folder could not be found or if the 133 file entry's information was invalid 134 * @throws SystemException if a system exception occurred 135 */ 136 @Override 137 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 138 long userId, long repositoryId, long folderId, 139 java.lang.String sourceFileName, java.lang.String mimeType, 140 java.lang.String title, java.lang.String description, 141 java.lang.String changeLog, java.io.File file, 142 com.liferay.portal.service.ServiceContext serviceContext) 143 throws com.liferay.portal.kernel.exception.PortalException, 144 com.liferay.portal.kernel.exception.SystemException { 145 return _dlAppLocalService.addFileEntry(userId, repositoryId, folderId, 146 sourceFileName, mimeType, title, description, changeLog, file, 147 serviceContext); 148 } 149 150 /** 151 * Adds a file entry and associated metadata based on an {@link InputStream} 152 * object. 153 * 154 * <p> 155 * This method takes two file names, the <code>sourceFileName</code> and the 156 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 157 * name of the actual file being uploaded. The <code>title</code> 158 * corresponds to a name the client wishes to assign this file after it has 159 * been uploaded to the portal. If it is <code>null</code>, the <code> 160 * sourceFileName</code> will be used. 161 * </p> 162 * 163 * @param userId the primary key of the file entry's creator/owner 164 * @param repositoryId the primary key of the repository 165 * @param folderId the primary key of the file entry's parent folder 166 * @param sourceFileName the original file's name 167 * @param mimeType the file's MIME type 168 * @param title the name to be assigned to the file (optionally <code>null 169 </code>) 170 * @param description the file's description 171 * @param changeLog the file's version change log 172 * @param is the file's data (optionally <code>null</code>) 173 * @param size the file's size (optionally <code>0</code>) 174 * @param serviceContext the service context to be applied. Can set the 175 asset category IDs, asset tag names, and expando bridge 176 attributes for the file entry. In a Liferay repository, it may 177 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 178 type </li> <li> fieldsMap - mapping for fields associated with a 179 custom file entry type </li> </ul> 180 * @return the file entry 181 * @throws PortalException if the parent folder could not be found or if the 182 file entry's information was invalid 183 * @throws SystemException if a system exception occurred 184 */ 185 @Override 186 public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry( 187 long userId, long repositoryId, long folderId, 188 java.lang.String sourceFileName, java.lang.String mimeType, 189 java.lang.String title, java.lang.String description, 190 java.lang.String changeLog, java.io.InputStream is, long size, 191 com.liferay.portal.service.ServiceContext serviceContext) 192 throws com.liferay.portal.kernel.exception.PortalException, 193 com.liferay.portal.kernel.exception.SystemException { 194 return _dlAppLocalService.addFileEntry(userId, repositoryId, folderId, 195 sourceFileName, mimeType, title, description, changeLog, is, size, 196 serviceContext); 197 } 198 199 /** 200 * Adds the file rank to the existing file entry. This method is only 201 * supported by the Liferay repository. 202 * 203 * @param repositoryId the primary key of the repository 204 * @param companyId the primary key of the company 205 * @param userId the primary key of the file rank's creator/owner 206 * @param fileEntryId the primary key of the file entry 207 * @param serviceContext the service context to be applied 208 * @return the file rank 209 * @throws SystemException if a system exception occurred 210 */ 211 @Override 212 public com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank( 213 long repositoryId, long companyId, long userId, long fileEntryId, 214 com.liferay.portal.service.ServiceContext serviceContext) 215 throws com.liferay.portal.kernel.exception.SystemException { 216 return _dlAppLocalService.addFileRank(repositoryId, companyId, userId, 217 fileEntryId, serviceContext); 218 } 219 220 /** 221 * Adds the file shortcut to the existing file entry. This method is only 222 * supported by the Liferay repository. 223 * 224 * @param userId the primary key of the file shortcut's creator/owner 225 * @param repositoryId the primary key of the repository 226 * @param folderId the primary key of the file shortcut's parent folder 227 * @param toFileEntryId the primary key of the file entry to point to 228 * @param serviceContext the service context to be applied. Can set the 229 asset category IDs, asset tag names, and expando bridge 230 attributes for the file entry. 231 * @return the file shortcut 232 * @throws PortalException if the parent folder or file entry could not be 233 found, or if the file shortcut's information was invalid 234 * @throws SystemException if a system exception occurred 235 */ 236 @Override 237 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 238 long userId, long repositoryId, long folderId, long toFileEntryId, 239 com.liferay.portal.service.ServiceContext serviceContext) 240 throws com.liferay.portal.kernel.exception.PortalException, 241 com.liferay.portal.kernel.exception.SystemException { 242 return _dlAppLocalService.addFileShortcut(userId, repositoryId, 243 folderId, toFileEntryId, serviceContext); 244 } 245 246 /** 247 * Adds a folder. 248 * 249 * @param userId the primary key of the folder's creator/owner 250 * @param repositoryId the primary key of the repository 251 * @param parentFolderId the primary key of the folder's parent folder 252 * @param name the folder's name 253 * @param description the folder's description 254 * @param serviceContext the service context to be applied. In a Liferay 255 repository, it may include mountPoint which is a boolean 256 specifying whether the folder is a facade for mounting a 257 third-party repository 258 * @return the folder 259 * @throws PortalException if the parent folder could not be found or if the 260 new folder's information was invalid 261 * @throws SystemException if a system exception occurred 262 */ 263 @Override 264 public com.liferay.portal.kernel.repository.model.Folder addFolder( 265 long userId, long repositoryId, long parentFolderId, 266 java.lang.String name, java.lang.String description, 267 com.liferay.portal.service.ServiceContext serviceContext) 268 throws com.liferay.portal.kernel.exception.PortalException, 269 com.liferay.portal.kernel.exception.SystemException { 270 return _dlAppLocalService.addFolder(userId, repositoryId, 271 parentFolderId, name, description, serviceContext); 272 } 273 274 /** 275 * Delete all data associated to the given repository. This method is only 276 * supported by the Liferay repository. 277 * 278 * @param repositoryId the primary key of the data's repository 279 * @throws PortalException if the repository could not be found 280 * @throws SystemException if a system exception occurred 281 */ 282 @Override 283 public void deleteAll(long repositoryId) 284 throws com.liferay.portal.kernel.exception.PortalException, 285 com.liferay.portal.kernel.exception.SystemException { 286 _dlAppLocalService.deleteAll(repositoryId); 287 } 288 289 /** 290 * Deletes the file entry. 291 * 292 * @param fileEntryId the primary key of the file entry 293 * @throws PortalException if the file entry could not be found 294 * @throws SystemException if a system exception occurred 295 */ 296 @Override 297 public void deleteFileEntry(long fileEntryId) 298 throws com.liferay.portal.kernel.exception.PortalException, 299 com.liferay.portal.kernel.exception.SystemException { 300 _dlAppLocalService.deleteFileEntry(fileEntryId); 301 } 302 303 /** 304 * Deletes the file ranks associated to a given file entry. This method is 305 * only supported by the Liferay repository. 306 * 307 * @param fileEntryId the primary key of the file entry 308 * @throws SystemException if a system exception occurred 309 */ 310 @Override 311 public void deleteFileRanksByFileEntryId(long fileEntryId) 312 throws com.liferay.portal.kernel.exception.SystemException { 313 _dlAppLocalService.deleteFileRanksByFileEntryId(fileEntryId); 314 } 315 316 /** 317 * Deletes the file ranks associated to a given user. This method is only 318 * supported by the Liferay repository. 319 * 320 * @param userId the primary key of the user 321 * @throws SystemException if a system exception occurred 322 */ 323 @Override 324 public void deleteFileRanksByUserId(long userId) 325 throws com.liferay.portal.kernel.exception.SystemException { 326 _dlAppLocalService.deleteFileRanksByUserId(userId); 327 } 328 329 /** 330 * Deletes the file shortcut. This method is only supported by the Liferay 331 * repository. 332 * 333 * @param dlFileShortcut the file shortcut 334 * @throws PortalException if the file shortcut could not be found 335 * @throws SystemException if a system exception occurred 336 */ 337 @Override 338 public void deleteFileShortcut( 339 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 340 throws com.liferay.portal.kernel.exception.PortalException, 341 com.liferay.portal.kernel.exception.SystemException { 342 _dlAppLocalService.deleteFileShortcut(dlFileShortcut); 343 } 344 345 /** 346 * Deletes the file shortcut. This method is only supported by the Liferay 347 * repository. 348 * 349 * @param fileShortcutId the primary key of the file shortcut 350 * @throws PortalException if the file shortcut could not be found 351 * @throws SystemException if a system exception occurred 352 */ 353 @Override 354 public void deleteFileShortcut(long fileShortcutId) 355 throws com.liferay.portal.kernel.exception.PortalException, 356 com.liferay.portal.kernel.exception.SystemException { 357 _dlAppLocalService.deleteFileShortcut(fileShortcutId); 358 } 359 360 /** 361 * Deletes all file shortcuts associated to the file entry. This method is 362 * only supported by the Liferay repository. 363 * 364 * @param toFileEntryId the primary key of the associated file entry 365 * @throws PortalException if the file shortcut for the file entry could not 366 be found 367 * @throws SystemException if a system exception occurred 368 */ 369 @Override 370 public void deleteFileShortcuts(long toFileEntryId) 371 throws com.liferay.portal.kernel.exception.PortalException, 372 com.liferay.portal.kernel.exception.SystemException { 373 _dlAppLocalService.deleteFileShortcuts(toFileEntryId); 374 } 375 376 /** 377 * Deletes the folder and all of its subfolders and file entries. 378 * 379 * @param folderId the primary key of the folder 380 * @throws PortalException if the folder could not be found 381 * @throws SystemException if a system exception occurred 382 */ 383 @Override 384 public void deleteFolder(long folderId) 385 throws com.liferay.portal.kernel.exception.PortalException, 386 com.liferay.portal.kernel.exception.SystemException { 387 _dlAppLocalService.deleteFolder(folderId); 388 } 389 390 /** 391 * Returns the file entry with the primary key. 392 * 393 * @param fileEntryId the primary key of the file entry 394 * @return the file entry with the primary key 395 * @throws PortalException if the file entry could not be found 396 * @throws SystemException if a system exception occurred 397 */ 398 @Override 399 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 400 long fileEntryId) 401 throws com.liferay.portal.kernel.exception.PortalException, 402 com.liferay.portal.kernel.exception.SystemException { 403 return _dlAppLocalService.getFileEntry(fileEntryId); 404 } 405 406 /** 407 * Returns the file entry with the title in the folder. 408 * 409 * @param groupId the primary key of the file entry's group 410 * @param folderId the primary key of the file entry's folder 411 * @param title the file entry's title 412 * @return the file entry with the title in the folder 413 * @throws PortalException if the file entry could not be found 414 * @throws SystemException if a system exception occurred 415 */ 416 @Override 417 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 418 long groupId, long folderId, java.lang.String title) 419 throws com.liferay.portal.kernel.exception.PortalException, 420 com.liferay.portal.kernel.exception.SystemException { 421 return _dlAppLocalService.getFileEntry(groupId, folderId, title); 422 } 423 424 /** 425 * Returns the file entry with the UUID and group. 426 * 427 * @param uuid the file entry's UUID 428 * @param groupId the primary key of the file entry's group 429 * @return the file entry with the UUID and group 430 * @throws PortalException if the file entry could not be found 431 * @throws SystemException if a system exception occurred 432 */ 433 @Override 434 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId( 435 java.lang.String uuid, long groupId) 436 throws com.liferay.portal.kernel.exception.PortalException, 437 com.liferay.portal.kernel.exception.SystemException { 438 return _dlAppLocalService.getFileEntryByUuidAndGroupId(uuid, groupId); 439 } 440 441 /** 442 * Returns the file ranks from the user. This method is only supported by 443 * the Liferay repository. 444 * 445 * @param repositoryId the primary key of the repository 446 * @param userId the primary key of the user 447 * @return the file ranks from the user 448 * @throws SystemException if a system exception occurred 449 */ 450 @Override 451 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks( 452 long repositoryId, long userId) 453 throws com.liferay.portal.kernel.exception.SystemException { 454 return _dlAppLocalService.getFileRanks(repositoryId, userId); 455 } 456 457 /** 458 * Returns the file shortcut with the primary key. This method is only 459 * supported by the Liferay repository. 460 * 461 * @param fileShortcutId the primary key of the file shortcut 462 * @return the file shortcut with the primary key 463 * @throws PortalException if the file shortcut could not be found 464 * @throws SystemException if a system exception occurred 465 */ 466 @Override 467 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 468 long fileShortcutId) 469 throws com.liferay.portal.kernel.exception.PortalException, 470 com.liferay.portal.kernel.exception.SystemException { 471 return _dlAppLocalService.getFileShortcut(fileShortcutId); 472 } 473 474 /** 475 * Returns the file version with the primary key. 476 * 477 * @param fileVersionId the primary key of the file version 478 * @return the file version with the primary key 479 * @throws PortalException if the file version could not be found 480 * @throws SystemException if a system exception occurred 481 */ 482 @Override 483 public com.liferay.portal.kernel.repository.model.FileVersion getFileVersion( 484 long fileVersionId) 485 throws com.liferay.portal.kernel.exception.PortalException, 486 com.liferay.portal.kernel.exception.SystemException { 487 return _dlAppLocalService.getFileVersion(fileVersionId); 488 } 489 490 /** 491 * Returns the folder with the primary key. 492 * 493 * @param folderId the primary key of the folder 494 * @return the folder with the primary key 495 * @throws PortalException if the folder could not be found 496 * @throws SystemException if a system exception occurred 497 */ 498 @Override 499 public com.liferay.portal.kernel.repository.model.Folder getFolder( 500 long folderId) 501 throws com.liferay.portal.kernel.exception.PortalException, 502 com.liferay.portal.kernel.exception.SystemException { 503 return _dlAppLocalService.getFolder(folderId); 504 } 505 506 /** 507 * Returns the folder with the name in the parent folder. 508 * 509 * @param repositoryId the primary key of the folder's repository 510 * @param parentFolderId the primary key of the folder's parent folder 511 * @param name the folder's name 512 * @return the folder with the name in the parent folder 513 * @throws PortalException if the folder could not be found 514 * @throws SystemException if a system exception occurred 515 */ 516 @Override 517 public com.liferay.portal.kernel.repository.model.Folder getFolder( 518 long repositoryId, long parentFolderId, java.lang.String name) 519 throws com.liferay.portal.kernel.exception.PortalException, 520 com.liferay.portal.kernel.exception.SystemException { 521 return _dlAppLocalService.getFolder(repositoryId, parentFolderId, name); 522 } 523 524 /** 525 * Returns the mount folder of the repository with the primary key. This 526 * method is only supported by the Liferay repository. 527 * 528 * @param repositoryId the primary key of the repository 529 * @return the folder used for mounting third-party repositories 530 * @throws PortalException if the repository or mount folder could not be 531 found 532 * @throws SystemException if a system exception occurred 533 */ 534 @Override 535 public com.liferay.portal.kernel.repository.model.Folder getMountFolder( 536 long repositoryId) 537 throws com.liferay.portal.kernel.exception.PortalException, 538 com.liferay.portal.kernel.exception.SystemException { 539 return _dlAppLocalService.getMountFolder(repositoryId); 540 } 541 542 /** 543 * Moves the file entry to the new folder. 544 * 545 * @param userId the primary key of the user 546 * @param fileEntryId the primary key of the file entry 547 * @param newFolderId the primary key of the new folder 548 * @param serviceContext the service context to be applied 549 * @return the file entry 550 * @throws PortalException if the file entry or the new folder could not be 551 found 552 * @throws SystemException if a system exception occurred 553 */ 554 @Override 555 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry( 556 long userId, long fileEntryId, long newFolderId, 557 com.liferay.portal.service.ServiceContext serviceContext) 558 throws com.liferay.portal.kernel.exception.PortalException, 559 com.liferay.portal.kernel.exception.SystemException { 560 return _dlAppLocalService.moveFileEntry(userId, fileEntryId, 561 newFolderId, serviceContext); 562 } 563 564 /** 565 * Moves the file entry with the primary key to the trash portlet. 566 * 567 * @param userId the primary key of the user 568 * @param fileEntryId the primary key of the file entry 569 * @return the file entry 570 * @throws PortalException if the file entry could not be found 571 * @throws SystemException if a system exception occurred 572 */ 573 @Override 574 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash( 575 long userId, long fileEntryId) 576 throws com.liferay.portal.kernel.exception.PortalException, 577 com.liferay.portal.kernel.exception.SystemException { 578 return _dlAppLocalService.moveFileEntryToTrash(userId, fileEntryId); 579 } 580 581 @Override 582 public com.liferay.portal.kernel.repository.model.Folder moveFolder( 583 long userId, long folderId, long parentFolderId, 584 com.liferay.portal.service.ServiceContext serviceContext) 585 throws com.liferay.portal.kernel.exception.PortalException, 586 com.liferay.portal.kernel.exception.SystemException { 587 return _dlAppLocalService.moveFolder(userId, folderId, parentFolderId, 588 serviceContext); 589 } 590 591 /** 592 * Restores the file entry with the primary key from the trash portlet. 593 * 594 * @param userId the primary key of the user 595 * @param fileEntryId the primary key of the file entry 596 * @throws PortalException if the file entry could not be found 597 * @throws SystemException if a system exception occurred 598 */ 599 @Override 600 public void restoreFileEntryFromTrash(long userId, long fileEntryId) 601 throws com.liferay.portal.kernel.exception.PortalException, 602 com.liferay.portal.kernel.exception.SystemException { 603 _dlAppLocalService.restoreFileEntryFromTrash(userId, fileEntryId); 604 } 605 606 /** 607 * Subscribe the user to changes in documents of the file entry type. This 608 * method is only supported by the Liferay repository. 609 * 610 * @param userId the primary key of the user 611 * @param groupId the primary key of the file entry type's group 612 * @param fileEntryTypeId the primary key of the file entry type 613 * @throws PortalException if the user or group could not be found 614 * @throws SystemException if a system exception occurred 615 */ 616 @Override 617 public void subscribeFileEntryType(long userId, long groupId, 618 long fileEntryTypeId) 619 throws com.liferay.portal.kernel.exception.PortalException, 620 com.liferay.portal.kernel.exception.SystemException { 621 _dlAppLocalService.subscribeFileEntryType(userId, groupId, 622 fileEntryTypeId); 623 } 624 625 /** 626 * Subscribe the user to document changes in the folder. This method is only 627 * supported by the Liferay repository. 628 * 629 * @param userId the primary key of the user 630 * @param groupId the primary key of the folder's group 631 * @param folderId the primary key of the folder 632 * @throws PortalException if the user or group could not be found 633 * @throws SystemException if a system exception occurred 634 */ 635 @Override 636 public void subscribeFolder(long userId, long groupId, long folderId) 637 throws com.liferay.portal.kernel.exception.PortalException, 638 com.liferay.portal.kernel.exception.SystemException { 639 _dlAppLocalService.subscribeFolder(userId, groupId, folderId); 640 } 641 642 /** 643 * Unsubscribe the user from changes in documents of the file entry type. 644 * This method is only supported by the Liferay repository. 645 * 646 * @param userId the primary key of the user 647 * @param groupId the primary key of the file entry type's group 648 * @param fileEntryTypeId the primary key of the file entry type 649 * @throws PortalException if the user or group could not be found 650 * @throws SystemException if a system exception occurred 651 */ 652 @Override 653 public void unsubscribeFileEntryType(long userId, long groupId, 654 long fileEntryTypeId) 655 throws com.liferay.portal.kernel.exception.PortalException, 656 com.liferay.portal.kernel.exception.SystemException { 657 _dlAppLocalService.unsubscribeFileEntryType(userId, groupId, 658 fileEntryTypeId); 659 } 660 661 /** 662 * Unsubscribe the user from document changes in the folder. This method is 663 * only supported by the Liferay repository. 664 * 665 * @param userId the primary key of the user 666 * @param groupId the primary key of the folder's group 667 * @param folderId the primary key of the folder 668 * @throws PortalException if the user or group could not be found 669 * @throws SystemException if a system exception occurred 670 */ 671 @Override 672 public void unsubscribeFolder(long userId, long groupId, long folderId) 673 throws com.liferay.portal.kernel.exception.PortalException, 674 com.liferay.portal.kernel.exception.SystemException { 675 _dlAppLocalService.unsubscribeFolder(userId, groupId, folderId); 676 } 677 678 /** 679 * Updates the file entry's asset replacing its asset categories, tags, and 680 * links. 681 * 682 * @param userId the primary key of the user 683 * @param fileEntry the file entry to update 684 * @param fileVersion the file version to update 685 * @param assetCategoryIds the primary keys of the new asset categories 686 * @param assetTagNames the new asset tag names 687 * @param assetLinkEntryIds the primary keys of the new asset link entries 688 * @throws PortalException if the file entry or version could not be found 689 * @throws SystemException if a system exception occurred 690 */ 691 @Override 692 public void updateAsset(long userId, 693 com.liferay.portal.kernel.repository.model.FileEntry fileEntry, 694 com.liferay.portal.kernel.repository.model.FileVersion fileVersion, 695 long[] assetCategoryIds, java.lang.String[] assetTagNames, 696 long[] assetLinkEntryIds) 697 throws com.liferay.portal.kernel.exception.PortalException, 698 com.liferay.portal.kernel.exception.SystemException { 699 _dlAppLocalService.updateAsset(userId, fileEntry, fileVersion, 700 assetCategoryIds, assetTagNames, assetLinkEntryIds); 701 } 702 703 /** 704 * Updates a file entry and associated metadata based on a byte array 705 * object. If the file data is <code>null</code>, then only the associated 706 * metadata (i.e., <code>title</code>, <code>description</code>, and 707 * parameters in the <code>serviceContext</code>) will be updated. 708 * 709 * <p> 710 * This method takes two file names, the <code>sourceFileName</code> and the 711 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 712 * name of the actual file being uploaded. The <code>title</code> 713 * corresponds to a name the client wishes to assign this file after it has 714 * been uploaded to the portal. 715 * </p> 716 * 717 * @param userId the primary key of the user 718 * @param fileEntryId the primary key of the file entry 719 * @param sourceFileName the original file's name (optionally 720 <code>null</code>) 721 * @param mimeType the file's MIME type (optionally <code>null</code>) 722 * @param title the new name to be assigned to the file (optionally <code> 723 <code>null</code></code>) 724 * @param description the file's new description 725 * @param changeLog the file's version change log (optionally 726 <code>null</code>) 727 * @param majorVersion whether the new file version is a major version 728 * @param bytes the file's data (optionally <code>null</code>) 729 * @param serviceContext the service context to be applied. Can set the 730 asset category IDs, asset tag names, and expando bridge 731 attributes for the file entry. In a Liferay repository, it may 732 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 733 type </li> <li> fieldsMap - mapping for fields associated with a 734 custom file entry type </li> </ul> 735 * @return the file entry 736 * @throws PortalException if the file entry could not be found 737 * @throws SystemException if a system exception occurred 738 */ 739 @Override 740 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 741 long userId, long fileEntryId, java.lang.String sourceFileName, 742 java.lang.String mimeType, java.lang.String title, 743 java.lang.String description, java.lang.String changeLog, 744 boolean majorVersion, byte[] bytes, 745 com.liferay.portal.service.ServiceContext serviceContext) 746 throws com.liferay.portal.kernel.exception.PortalException, 747 com.liferay.portal.kernel.exception.SystemException { 748 return _dlAppLocalService.updateFileEntry(userId, fileEntryId, 749 sourceFileName, mimeType, title, description, changeLog, 750 majorVersion, bytes, serviceContext); 751 } 752 753 /** 754 * Updates a file entry and associated metadata based on a {@link 755 * java.io.File} object. If the file data is <code>null</code>, then only 756 * the associated metadata (i.e., <code>title</code>, 757 * <code>description</code>, and parameters in the 758 * <code>serviceContext</code>) will be updated. 759 * 760 * <p> 761 * This method takes two file names, the <code>sourceFileName</code> and the 762 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 763 * name of the actual file being uploaded. The <code>title</code> 764 * corresponds to a name the client wishes to assign this file after it has 765 * been uploaded to the portal. 766 * </p> 767 * 768 * @param userId the primary key of the user 769 * @param fileEntryId the primary key of the file entry 770 * @param sourceFileName the original file's name (optionally 771 <code>null</code>) 772 * @param mimeType the file's MIME type (optionally <code>null</code>) 773 * @param title the new name to be assigned to the file (optionally <code> 774 <code>null</code></code>) 775 * @param description the file's new description 776 * @param changeLog the file's version change log (optionally 777 <code>null</code>) 778 * @param majorVersion whether the new file version is a major version 779 * @param file the file's data (optionally <code>null</code>) 780 * @param serviceContext the service context to be applied. Can set the 781 asset category IDs, asset tag names, and expando bridge 782 attributes for the file entry. In a Liferay repository, it may 783 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 784 type </li> <li> fieldsMap - mapping for fields associated with a 785 custom file entry type </li> </ul> 786 * @return the file entry 787 * @throws PortalException if the file entry could not be found 788 * @throws SystemException if a system exception occurred 789 */ 790 @Override 791 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 792 long userId, long fileEntryId, java.lang.String sourceFileName, 793 java.lang.String mimeType, java.lang.String title, 794 java.lang.String description, java.lang.String changeLog, 795 boolean majorVersion, java.io.File file, 796 com.liferay.portal.service.ServiceContext serviceContext) 797 throws com.liferay.portal.kernel.exception.PortalException, 798 com.liferay.portal.kernel.exception.SystemException { 799 return _dlAppLocalService.updateFileEntry(userId, fileEntryId, 800 sourceFileName, mimeType, title, description, changeLog, 801 majorVersion, file, serviceContext); 802 } 803 804 /** 805 * Updates a file entry and associated metadata based on an {@link 806 * InputStream} object. If the file data is <code>null</code>, then only the 807 * associated metadata (i.e., <code>title</code>, <code>description</code>, 808 * and parameters in the <code>serviceContext</code>) will be updated. 809 * 810 * <p> 811 * This method takes two file names, the <code>sourceFileName</code> and the 812 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 813 * name of the actual file being uploaded. The <code>title</code> 814 * corresponds to a name the client wishes to assign this file after it has 815 * been uploaded to the portal. 816 * </p> 817 * 818 * @param userId the primary key of the user 819 * @param fileEntryId the primary key of the file entry 820 * @param sourceFileName the original file's name (optionally 821 <code>null</code>) 822 * @param mimeType the file's MIME type (optionally <code>null</code>) 823 * @param title the new name to be assigned to the file (optionally <code> 824 <code>null</code></code>) 825 * @param description the file's new description 826 * @param changeLog the file's version change log (optionally 827 <code>null</code>) 828 * @param majorVersion whether the new file version is a major version 829 * @param is the file's data (optionally <code>null</code>) 830 * @param size the file's size (optionally <code>0</code>) 831 * @param serviceContext the service context to be applied. Can set the 832 asset category IDs, asset tag names, and expando bridge 833 attributes for the file entry. In a Liferay repository, it may 834 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 835 type </li> <li> fieldsMap - mapping for fields associated with a 836 custom file entry type </li> </ul> 837 * @return the file entry 838 * @throws PortalException if the file entry could not be found 839 * @throws SystemException if a system exception occurred 840 */ 841 @Override 842 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 843 long userId, long fileEntryId, java.lang.String sourceFileName, 844 java.lang.String mimeType, java.lang.String title, 845 java.lang.String description, java.lang.String changeLog, 846 boolean majorVersion, java.io.InputStream is, long size, 847 com.liferay.portal.service.ServiceContext serviceContext) 848 throws com.liferay.portal.kernel.exception.PortalException, 849 com.liferay.portal.kernel.exception.SystemException { 850 return _dlAppLocalService.updateFileEntry(userId, fileEntryId, 851 sourceFileName, mimeType, title, description, changeLog, 852 majorVersion, is, size, serviceContext); 853 } 854 855 /** 856 * Updates a file rank to the existing file entry. This method is only 857 * supported by the Liferay repository. 858 * 859 * @param repositoryId the primary key of the file rank's repository 860 * @param companyId the primary key of the file rank's company 861 * @param userId the primary key of the file rank's creator/owner 862 * @param fileEntryId the primary key of the file rank's file entry 863 * @param serviceContext the service context to be applied 864 * @return the file rank 865 * @throws SystemException if a system exception occurred 866 */ 867 @Override 868 public com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank( 869 long repositoryId, long companyId, long userId, long fileEntryId, 870 com.liferay.portal.service.ServiceContext serviceContext) 871 throws com.liferay.portal.kernel.exception.SystemException { 872 return _dlAppLocalService.updateFileRank(repositoryId, companyId, 873 userId, fileEntryId, serviceContext); 874 } 875 876 /** 877 * Updates a file shortcut to the existing file entry. This method is only 878 * supported by the Liferay repository. 879 * 880 * @param userId the primary key of the file shortcut's creator/owner 881 * @param fileShortcutId the primary key of the file shortcut 882 * @param folderId the primary key of the file shortcut's parent folder 883 * @param toFileEntryId the primary key of the file shortcut's file entry 884 * @param serviceContext the service context to be applied. Can set the 885 asset category IDs, asset tag names, and expando bridge 886 attributes for the file entry. 887 * @return the file shortcut 888 * @throws PortalException if the file shortcut, folder, or file entry could 889 not be found 890 * @throws SystemException if a system exception occurred 891 */ 892 @Override 893 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 894 long userId, long fileShortcutId, long folderId, long toFileEntryId, 895 com.liferay.portal.service.ServiceContext serviceContext) 896 throws com.liferay.portal.kernel.exception.PortalException, 897 com.liferay.portal.kernel.exception.SystemException { 898 return _dlAppLocalService.updateFileShortcut(userId, fileShortcutId, 899 folderId, toFileEntryId, serviceContext); 900 } 901 902 /** 903 * Updates all file shortcuts to the existing file entry to the new file 904 * entry. This method is only supported by the Liferay repository. 905 * 906 * @param toRepositoryId the primary key of the repository 907 * @param oldToFileEntryId the primary key of the old file entry pointed to 908 * @param newToFileEntryId the primary key of the new file entry to point 909 to 910 * @throws SystemException if a system exception occurred 911 */ 912 @Override 913 public void updateFileShortcuts(long toRepositoryId, long oldToFileEntryId, 914 long newToFileEntryId) 915 throws com.liferay.portal.kernel.exception.SystemException { 916 _dlAppLocalService.updateFileShortcuts(toRepositoryId, 917 oldToFileEntryId, newToFileEntryId); 918 } 919 920 /** 921 * Updates the folder. 922 * 923 * @param folderId the primary key of the folder 924 * @param parentFolderId the primary key of the folder's new parent folder 925 * @param name the folder's new name 926 * @param description the folder's new description 927 * @param serviceContext the service context to be applied. In a Liferay 928 repository, it may include: <ul> <li> defaultFileEntryTypeId - 929 the file entry type to default all Liferay file entries to </li> 930 <li> dlFileEntryTypesSearchContainerPrimaryKeys - a 931 comma-delimited list of file entry type primary keys allowed in 932 the given folder and all descendants </li> <li> 933 overrideFileEntryTypes - boolean specifying whether to override 934 ancestral folder's restriction of file entry types allowed </li> 935 <li> workflowDefinitionXYZ - the workflow definition name 936 specified per file entry type. The parameter name must be the 937 string <code>workflowDefinition</code> appended by the <code> 938 fileEntryTypeId</code> (optionally <code>0</code>). </li> </ul> 939 * @return the folder 940 * @throws PortalException if the current or new parent folder could not be 941 found, or if the new parent folder's information was invalid 942 * @throws SystemException if a system exception occurred 943 */ 944 @Override 945 public com.liferay.portal.kernel.repository.model.Folder updateFolder( 946 long folderId, long parentFolderId, java.lang.String name, 947 java.lang.String description, 948 com.liferay.portal.service.ServiceContext serviceContext) 949 throws com.liferay.portal.kernel.exception.PortalException, 950 com.liferay.portal.kernel.exception.SystemException { 951 return _dlAppLocalService.updateFolder(folderId, parentFolderId, name, 952 description, serviceContext); 953 } 954 955 /** 956 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 957 */ 958 public DLAppLocalService getWrappedDLAppLocalService() { 959 return _dlAppLocalService; 960 } 961 962 /** 963 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 964 */ 965 public void setWrappedDLAppLocalService(DLAppLocalService dlAppLocalService) { 966 _dlAppLocalService = dlAppLocalService; 967 } 968 969 @Override 970 public DLAppLocalService getWrappedService() { 971 return _dlAppLocalService; 972 } 973 974 @Override 975 public void setWrappedService(DLAppLocalService dlAppLocalService) { 976 _dlAppLocalService = dlAppLocalService; 977 } 978 979 private DLAppLocalService _dlAppLocalService; 980 }