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