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