001 /** 002 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.documentlibrary.service; 016 017 import com.liferay.portal.service.ServiceWrapper; 018 019 /** 020 * <p> 021 * This class is a wrapper for {@link 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 SystemException if a system exception occurred 204 */ 205 public com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank( 206 long repositoryId, long companyId, long userId, long fileEntryId, 207 com.liferay.portal.service.ServiceContext serviceContext) 208 throws com.liferay.portal.kernel.exception.SystemException { 209 return _dlAppLocalService.addFileRank(repositoryId, companyId, userId, 210 fileEntryId, serviceContext); 211 } 212 213 /** 214 * Adds the file shortcut to the existing file entry. This method is only 215 * supported by the Liferay repository. 216 * 217 * @param userId the primary key of the file shortcut's creator/owner 218 * @param repositoryId the primary key of the repository 219 * @param folderId the primary key of the file shortcut's parent folder 220 * @param toFileEntryId the primary key of the file entry to point to 221 * @param serviceContext the service context to be applied. Can set the 222 asset category IDs, asset tag names, and expando bridge 223 attributes for the file entry. 224 * @return the file shortcut 225 * @throws PortalException if the parent folder or file entry could not be 226 found, or if the file shortcut's information was invalid 227 * @throws SystemException if a system exception occurred 228 */ 229 public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut( 230 long userId, long repositoryId, long folderId, long toFileEntryId, 231 com.liferay.portal.service.ServiceContext serviceContext) 232 throws com.liferay.portal.kernel.exception.PortalException, 233 com.liferay.portal.kernel.exception.SystemException { 234 return _dlAppLocalService.addFileShortcut(userId, repositoryId, 235 folderId, toFileEntryId, serviceContext); 236 } 237 238 /** 239 * Adds a folder. 240 * 241 * @param userId the primary key of the folder's creator/owner 242 * @param repositoryId the primary key of the repository 243 * @param parentFolderId the primary key of the folder's parent folder 244 * @param name the folder's name 245 * @param description the folder's description 246 * @param serviceContext the service context to be applied. In a Liferay 247 repository, it may include mountPoint which is a boolean 248 specifying whether the folder is a facade for mounting a 249 third-party repository 250 * @return the folder 251 * @throws PortalException if the parent folder could not be found or if the 252 new folder's information was invalid 253 * @throws SystemException if a system exception occurred 254 */ 255 public com.liferay.portal.kernel.repository.model.Folder addFolder( 256 long userId, long repositoryId, long parentFolderId, 257 java.lang.String name, java.lang.String description, 258 com.liferay.portal.service.ServiceContext serviceContext) 259 throws com.liferay.portal.kernel.exception.PortalException, 260 com.liferay.portal.kernel.exception.SystemException { 261 return _dlAppLocalService.addFolder(userId, repositoryId, 262 parentFolderId, name, description, serviceContext); 263 } 264 265 /** 266 * Delete all data associated to the given repository. This method is only 267 * supported by the Liferay repository. 268 * 269 * @param repositoryId the primary key of the data's repository 270 * @throws PortalException if the repository could not be found 271 * @throws SystemException if a system exception occurred 272 */ 273 public void deleteAll(long repositoryId) 274 throws com.liferay.portal.kernel.exception.PortalException, 275 com.liferay.portal.kernel.exception.SystemException { 276 _dlAppLocalService.deleteAll(repositoryId); 277 } 278 279 /** 280 * Deletes the file entry. 281 * 282 * @param fileEntryId the primary key of the file entry 283 * @throws PortalException if the file entry could not be found 284 * @throws SystemException if a system exception occurred 285 */ 286 public void deleteFileEntry(long fileEntryId) 287 throws com.liferay.portal.kernel.exception.PortalException, 288 com.liferay.portal.kernel.exception.SystemException { 289 _dlAppLocalService.deleteFileEntry(fileEntryId); 290 } 291 292 /** 293 * Deletes the file ranks associated to a given file entry. This method is 294 * only supported by the Liferay repository. 295 * 296 * @param fileEntryId the primary key of the file entry 297 * @throws SystemException if a system exception occurred 298 */ 299 public void deleteFileRanksByFileEntryId(long fileEntryId) 300 throws com.liferay.portal.kernel.exception.SystemException { 301 _dlAppLocalService.deleteFileRanksByFileEntryId(fileEntryId); 302 } 303 304 /** 305 * Deletes the file ranks associated to a given user. This method is only 306 * supported by the Liferay repository. 307 * 308 * @param userId the primary key of the user 309 * @throws SystemException if a system exception occurred 310 */ 311 public void deleteFileRanksByUserId(long userId) 312 throws com.liferay.portal.kernel.exception.SystemException { 313 _dlAppLocalService.deleteFileRanksByUserId(userId); 314 } 315 316 /** 317 * Deletes the file shortcut. This method is only supported by the Liferay 318 * repository. 319 * 320 * @param dlFileShortcut the file shortcut 321 * @throws PortalException if the file shortcut could not be found 322 * @throws SystemException if a system exception occurred 323 */ 324 public void deleteFileShortcut( 325 com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 326 throws com.liferay.portal.kernel.exception.PortalException, 327 com.liferay.portal.kernel.exception.SystemException { 328 _dlAppLocalService.deleteFileShortcut(dlFileShortcut); 329 } 330 331 /** 332 * Deletes the file shortcut. This method is only supported by the Liferay 333 * repository. 334 * 335 * @param fileShortcutId the primary key of the file shortcut 336 * @throws PortalException if the file shortcut could not be found 337 * @throws SystemException if a system exception occurred 338 */ 339 public void deleteFileShortcut(long fileShortcutId) 340 throws com.liferay.portal.kernel.exception.PortalException, 341 com.liferay.portal.kernel.exception.SystemException { 342 _dlAppLocalService.deleteFileShortcut(fileShortcutId); 343 } 344 345 /** 346 * Deletes all file shortcuts associated to the file entry. This method is 347 * only supported by the Liferay repository. 348 * 349 * @param toFileEntryId the primary key of the associated file entry 350 * @throws PortalException if the file shortcut for the file entry could not 351 be found 352 * @throws SystemException if a system exception occurred 353 */ 354 public void deleteFileShortcuts(long toFileEntryId) 355 throws com.liferay.portal.kernel.exception.PortalException, 356 com.liferay.portal.kernel.exception.SystemException { 357 _dlAppLocalService.deleteFileShortcuts(toFileEntryId); 358 } 359 360 /** 361 * Deletes the folder and all of its subfolders and file entries. 362 * 363 * @param folderId the primary key of the folder 364 * @throws PortalException if the folder could not be found 365 * @throws SystemException if a system exception occurred 366 */ 367 public void deleteFolder(long folderId) 368 throws com.liferay.portal.kernel.exception.PortalException, 369 com.liferay.portal.kernel.exception.SystemException { 370 _dlAppLocalService.deleteFolder(folderId); 371 } 372 373 /** 374 * Returns the file entry with the primary key. 375 * 376 * @param fileEntryId the primary key of the file entry 377 * @return the file entry with the primary key 378 * @throws PortalException if the file entry could not be found 379 * @throws SystemException if a system exception occurred 380 */ 381 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 382 long fileEntryId) 383 throws com.liferay.portal.kernel.exception.PortalException, 384 com.liferay.portal.kernel.exception.SystemException { 385 return _dlAppLocalService.getFileEntry(fileEntryId); 386 } 387 388 /** 389 * Returns the file entry with the title in the folder. 390 * 391 * @param groupId the primary key of the file entry's group 392 * @param folderId the primary key of the file entry's folder 393 * @param title the file entry's title 394 * @return the file entry with the title in the folder 395 * @throws PortalException if the file entry could not be found 396 * @throws SystemException if a system exception occurred 397 */ 398 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry( 399 long groupId, long folderId, java.lang.String title) 400 throws com.liferay.portal.kernel.exception.PortalException, 401 com.liferay.portal.kernel.exception.SystemException { 402 return _dlAppLocalService.getFileEntry(groupId, folderId, title); 403 } 404 405 /** 406 * Returns the file entry with the UUID and group. 407 * 408 * @param uuid the file entry's universally unique identifier 409 * @param groupId the primary key of the file entry's group 410 * @return the file entry with the UUID and group 411 * @throws PortalException if the file entry could not be found 412 * @throws SystemException if a system exception occurred 413 */ 414 public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId( 415 java.lang.String uuid, long groupId) 416 throws com.liferay.portal.kernel.exception.PortalException, 417 com.liferay.portal.kernel.exception.SystemException { 418 return _dlAppLocalService.getFileEntryByUuidAndGroupId(uuid, groupId); 419 } 420 421 /** 422 * Returns the file ranks from the user. This method is only supported by 423 * the Liferay repository. 424 * 425 * @param repositoryId the primary key of the repository 426 * @param userId the primary key of the user 427 * @return the file ranks from the user 428 * @throws SystemException if a system exception occurred 429 */ 430 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks( 431 long repositoryId, long userId) 432 throws com.liferay.portal.kernel.exception.SystemException { 433 return _dlAppLocalService.getFileRanks(repositoryId, userId); 434 } 435 436 /** 437 * Returns the file shortcut with the primary key. This method is only 438 * supported by the Liferay repository. 439 * 440 * @param fileShortcutId the primary key of the file shortcut 441 * @return the file shortcut with the primary key 442 * @throws PortalException if the file shortcut could not be found 443 * @throws SystemException if a system exception occurred 444 */ 445 public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut( 446 long fileShortcutId) 447 throws com.liferay.portal.kernel.exception.PortalException, 448 com.liferay.portal.kernel.exception.SystemException { 449 return _dlAppLocalService.getFileShortcut(fileShortcutId); 450 } 451 452 /** 453 * Returns the file version with the primary key. 454 * 455 * @param fileVersionId the primary key of the file version 456 * @return the file version with the primary key 457 * @throws PortalException if the file version could not be found 458 * @throws SystemException if a system exception occurred 459 */ 460 public com.liferay.portal.kernel.repository.model.FileVersion getFileVersion( 461 long fileVersionId) 462 throws com.liferay.portal.kernel.exception.PortalException, 463 com.liferay.portal.kernel.exception.SystemException { 464 return _dlAppLocalService.getFileVersion(fileVersionId); 465 } 466 467 /** 468 * Returns the folder with the primary key. 469 * 470 * @param folderId the primary key of the folder 471 * @return the folder with the primary key 472 * @throws PortalException if the folder could not be found 473 * @throws SystemException if a system exception occurred 474 */ 475 public com.liferay.portal.kernel.repository.model.Folder getFolder( 476 long folderId) 477 throws com.liferay.portal.kernel.exception.PortalException, 478 com.liferay.portal.kernel.exception.SystemException { 479 return _dlAppLocalService.getFolder(folderId); 480 } 481 482 /** 483 * Returns the folder with the name in the parent folder. 484 * 485 * @param repositoryId the primary key of the folder's repository 486 * @param parentFolderId the primary key of the folder's parent folder 487 * @param name the folder's name 488 * @return the folder with the name in the parent folder 489 * @throws PortalException if the folder could not be found 490 * @throws SystemException if a system exception occurred 491 */ 492 public com.liferay.portal.kernel.repository.model.Folder getFolder( 493 long repositoryId, long parentFolderId, java.lang.String name) 494 throws com.liferay.portal.kernel.exception.PortalException, 495 com.liferay.portal.kernel.exception.SystemException { 496 return _dlAppLocalService.getFolder(repositoryId, parentFolderId, name); 497 } 498 499 /** 500 * Returns the mount folder of the repository with the primary key. This 501 * method is only supported by the Liferay repository. 502 * 503 * @param repositoryId the primary key of the repository 504 * @return the folder used for mounting third-party repositories 505 * @throws PortalException if the repository or mount folder could not be 506 found 507 * @throws SystemException if a system exception occurred 508 */ 509 public com.liferay.portal.kernel.repository.model.Folder getMountFolder( 510 long repositoryId) 511 throws com.liferay.portal.kernel.exception.PortalException, 512 com.liferay.portal.kernel.exception.SystemException { 513 return _dlAppLocalService.getMountFolder(repositoryId); 514 } 515 516 /** 517 * Moves the file entry to the new folder. 518 * 519 * @param userId the primary key of the user 520 * @param fileEntryId the primary key of the file entry 521 * @param newFolderId the primary key of the new folder 522 * @param serviceContext the service context to be applied 523 * @return the file entry 524 * @throws PortalException if the file entry or the new folder could not be 525 found 526 * @throws SystemException if a system exception occurred 527 */ 528 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry( 529 long userId, long fileEntryId, long newFolderId, 530 com.liferay.portal.service.ServiceContext serviceContext) 531 throws com.liferay.portal.kernel.exception.PortalException, 532 com.liferay.portal.kernel.exception.SystemException { 533 return _dlAppLocalService.moveFileEntry(userId, fileEntryId, 534 newFolderId, serviceContext); 535 } 536 537 /** 538 * Moves the file entry with the primary key to the trash portlet. 539 * 540 * @param userId the primary key of the user 541 * @param fileEntryId the primary key of the file entry 542 * @throws PortalException if the file entry could not be found 543 * @throws SystemException if a system exception occurred 544 */ 545 public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash( 546 long userId, long fileEntryId) 547 throws com.liferay.portal.kernel.exception.PortalException, 548 com.liferay.portal.kernel.exception.SystemException { 549 return _dlAppLocalService.moveFileEntryToTrash(userId, fileEntryId); 550 } 551 552 /** 553 * Restores the file entry with the primary key from the trash portlet. 554 * 555 * @param userId the primary key of the user 556 * @param fileEntryId the primary key of the file entry 557 * @throws PortalException if the file entry could not be found 558 * @throws SystemException if a system exception occurred 559 */ 560 public void restoreFileEntryFromTrash(long userId, long fileEntryId) 561 throws com.liferay.portal.kernel.exception.PortalException, 562 com.liferay.portal.kernel.exception.SystemException { 563 _dlAppLocalService.restoreFileEntryFromTrash(userId, fileEntryId); 564 } 565 566 /** 567 * Updates the file entry's asset replacing its asset categories, tags, and 568 * links. 569 * 570 * @param userId the primary key of the user 571 * @param fileEntry the file entry to update 572 * @param fileVersion the file version to update 573 * @param assetCategoryIds the primary keys of the new asset categories 574 * @param assetTagNames the new asset tag names 575 * @param assetLinkEntryIds the primary keys of the new asset link entries 576 * @throws PortalException if the file entry or version could not be found 577 * @throws SystemException if a system exception occurred 578 */ 579 public void updateAsset(long userId, 580 com.liferay.portal.kernel.repository.model.FileEntry fileEntry, 581 com.liferay.portal.kernel.repository.model.FileVersion fileVersion, 582 long[] assetCategoryIds, java.lang.String[] assetTagNames, 583 long[] assetLinkEntryIds) 584 throws com.liferay.portal.kernel.exception.PortalException, 585 com.liferay.portal.kernel.exception.SystemException { 586 _dlAppLocalService.updateAsset(userId, fileEntry, fileVersion, 587 assetCategoryIds, assetTagNames, assetLinkEntryIds); 588 } 589 590 /** 591 * Updates a file entry and associated metadata based on a byte array 592 * object. If the file data is <code>null</code>, then only the associated 593 * metadata (i.e., <code>title</code>, <code>description</code>, and 594 * parameters in the <code>serviceContext</code>) will be updated. 595 * 596 * <p> 597 * This method takes two file names, the <code>sourceFileName</code> and the 598 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 599 * name of the actual file being uploaded. The <code>title</code> 600 * corresponds to a name the client wishes to assign this file after it has 601 * been uploaded to the portal. 602 * </p> 603 * 604 * @param userId the primary key of the user 605 * @param fileEntryId the primary key of the file entry 606 * @param sourceFileName the original file's name (optionally 607 <code>null</code>) 608 * @param mimeType the file's MIME type (optionally <code>null</code>) 609 * @param title the new name to be assigned to the file (optionally <code> 610 <code>null</code></code>) 611 * @param description the file's new description 612 * @param changeLog the file's version change log (optionally 613 <code>null</code>) 614 * @param majorVersion whether the new file version is a major version 615 * @param bytes the file's data (optionally <code>null</code>) 616 * @param serviceContext the service context to be applied. Can set the 617 asset category IDs, asset tag names, and expando bridge 618 attributes for the file entry. In a Liferay repository, it may 619 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 620 type </li> <li> fieldsMap - mapping for fields associated with a 621 custom file entry type </li> </ul> 622 * @return the file entry 623 * @throws PortalException if the file entry could not be found 624 * @throws SystemException if a system exception occurred 625 */ 626 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 627 long userId, long fileEntryId, java.lang.String sourceFileName, 628 java.lang.String mimeType, java.lang.String title, 629 java.lang.String description, java.lang.String changeLog, 630 boolean majorVersion, byte[] bytes, 631 com.liferay.portal.service.ServiceContext serviceContext) 632 throws com.liferay.portal.kernel.exception.PortalException, 633 com.liferay.portal.kernel.exception.SystemException { 634 return _dlAppLocalService.updateFileEntry(userId, fileEntryId, 635 sourceFileName, mimeType, title, description, changeLog, 636 majorVersion, bytes, serviceContext); 637 } 638 639 /** 640 * Updates a file entry and associated metadata based on a {@link 641 * java.io.File} object. If the file data is <code>null</code>, then only 642 * the associated metadata (i.e., <code>title</code>, 643 * <code>description</code>, and parameters in the 644 * <code>serviceContext</code>) will be updated. 645 * 646 * <p> 647 * This method takes two file names, the <code>sourceFileName</code> and the 648 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 649 * name of the actual file being uploaded. The <code>title</code> 650 * corresponds to a name the client wishes to assign this file after it has 651 * been uploaded to the portal. 652 * </p> 653 * 654 * @param userId the primary key of the user 655 * @param fileEntryId the primary key of the file entry 656 * @param sourceFileName the original file's name (optionally 657 <code>null</code>) 658 * @param mimeType the file's MIME type (optionally <code>null</code>) 659 * @param title the new name to be assigned to the file (optionally <code> 660 <code>null</code></code>) 661 * @param description the file's new description 662 * @param changeLog the file's version change log (optionally 663 <code>null</code>) 664 * @param majorVersion whether the new file version is a major version 665 * @param file EntryId the primary key of the file entry 666 * @param serviceContext the service context to be applied. Can set the 667 asset category IDs, asset tag names, and expando bridge 668 attributes for the file entry. In a Liferay repository, it may 669 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 670 type </li> <li> fieldsMap - mapping for fields associated with a 671 custom file entry type </li> </ul> 672 * @return the file entry 673 * @throws PortalException if the file entry could not be found 674 * @throws SystemException if a system exception occurred 675 */ 676 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 677 long userId, long fileEntryId, java.lang.String sourceFileName, 678 java.lang.String mimeType, java.lang.String title, 679 java.lang.String description, java.lang.String changeLog, 680 boolean majorVersion, java.io.File file, 681 com.liferay.portal.service.ServiceContext serviceContext) 682 throws com.liferay.portal.kernel.exception.PortalException, 683 com.liferay.portal.kernel.exception.SystemException { 684 return _dlAppLocalService.updateFileEntry(userId, fileEntryId, 685 sourceFileName, mimeType, title, description, changeLog, 686 majorVersion, file, serviceContext); 687 } 688 689 /** 690 * Updates a file entry and associated metadata based on an {@link java.io. 691 * InputStream} object. If the file data is <code>null</code>, then only the 692 * associated metadata (i.e., <code>title</code>, <code>description</code>, 693 * and parameters in the <code>serviceContext</code>) will be updated. 694 * 695 * <p> 696 * This method takes two file names, the <code>sourceFileName</code> and the 697 * <code>title</code>. The <code>sourceFileName</code> corresponds to the 698 * name of the actual file being uploaded. The <code>title</code> 699 * corresponds to a name the client wishes to assign this file after it has 700 * been uploaded to the portal. 701 * </p> 702 * 703 * @param userId the primary key of the user 704 * @param fileEntryId the primary key of the file entry 705 * @param sourceFileName the original file's name (optionally 706 <code>null</code>) 707 * @param mimeType the file's MIME type (optionally <code>null</code>) 708 * @param title the new name to be assigned to the file (optionally <code> 709 <code>null</code></code>) 710 * @param description the file's new description 711 * @param changeLog the file's version change log (optionally 712 <code>null</code>) 713 * @param majorVersion whether the new file version is a major version 714 * @param is the file's data (optionally <code>null</code>) 715 * @param size the file's size (optionally <code>0</code>) 716 * @param serviceContext the service context to be applied. Can set the 717 asset category IDs, asset tag names, and expando bridge 718 attributes for the file entry. In a Liferay repository, it may 719 include: <ul> <li> fileEntryTypeId - ID for a custom file entry 720 type </li> <li> fieldsMap - mapping for fields associated with a 721 custom file entry type </li> </ul> 722 * @return the file entry 723 * @throws PortalException if the file entry could not be found 724 * @throws SystemException if a system exception occurred 725 */ 726 public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry( 727 long userId, long fileEntryId, java.lang.String sourceFileName, 728 java.lang.String mimeType, java.lang.String title, 729 java.lang.String description, java.lang.String changeLog, 730 boolean majorVersion, java.io.InputStream is, long size, 731 com.liferay.portal.service.ServiceContext serviceContext) 732 throws com.liferay.portal.kernel.exception.PortalException, 733 com.liferay.portal.kernel.exception.SystemException { 734 return _dlAppLocalService.updateFileEntry(userId, fileEntryId, 735 sourceFileName, mimeType, title, description, changeLog, 736 majorVersion, is, size, serviceContext); 737 } 738 739 /** 740 * Updates a file rank to the existing file entry. This method is only 741 * supported by the Liferay repository. 742 * 743 * @param repositoryId the primary key of the file rank's repository 744 * @param companyId the primary key of the file rank's company 745 * @param userId the primary key of the file rank's creator/owner 746 * @param fileEntryId the primary key of the file rank's file entry 747 * @param serviceContext the service context to be applied 748 * @return the file rank 749 * @throws SystemException if a system exception occurred 750 */ 751 public com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank( 752 long repositoryId, long companyId, long userId, long fileEntryId, 753 com.liferay.portal.service.ServiceContext serviceContext) 754 throws com.liferay.portal.kernel.exception.SystemException { 755 return _dlAppLocalService.updateFileRank(repositoryId, companyId, 756 userId, fileEntryId, serviceContext); 757 } 758 759 /** 760 * Updates a file shortcut to the existing file entry. This method is only 761 * supported by the Liferay repository. 762 * 763 * @param userId the primary key of the file shortcut's creator/owner 764 * @param fileShortcutId the primary key of the file shortcut 765 * @param folderId the primary key of the file shortcut's parent folder 766 * @param toFileEntryId the primary key of the file shortcut's file entry 767 * @param serviceContext the service context to be applied. Can set the 768 asset category IDs, asset tag names, and expando bridge 769 attributes for the file entry. 770 * @return the file shortcut 771 * @throws PortalException if the file shortcut, folder, or file entry could 772 not be found 773 * @throws SystemException if a system exception occurred 774 */ 775 public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut( 776 long userId, long fileShortcutId, long folderId, long toFileEntryId, 777 com.liferay.portal.service.ServiceContext serviceContext) 778 throws com.liferay.portal.kernel.exception.PortalException, 779 com.liferay.portal.kernel.exception.SystemException { 780 return _dlAppLocalService.updateFileShortcut(userId, fileShortcutId, 781 folderId, toFileEntryId, serviceContext); 782 } 783 784 /** 785 * Updates all file shortcuts to the existing file entry to the new file 786 * entry. This method is only supported by the Liferay repository. 787 * 788 * @param toRepositoryId the primary key of the repository 789 * @param oldToFileEntryId the primary key of the old file entry pointed to 790 * @param newToFileEntryId the primary key of the new file entry to point 791 to 792 * @throws SystemException if a system exception occurred 793 */ 794 public void updateFileShortcuts(long toRepositoryId, long oldToFileEntryId, 795 long newToFileEntryId) 796 throws com.liferay.portal.kernel.exception.SystemException { 797 _dlAppLocalService.updateFileShortcuts(toRepositoryId, 798 oldToFileEntryId, newToFileEntryId); 799 } 800 801 /** 802 * Updates the folder. 803 * 804 * @param folderId the primary key of the folder 805 * @param parentFolderId the primary key of the folder's new parent folder 806 * @param name the folder's new name 807 * @param description the folder's new description 808 * @param serviceContext the service context to be applied. In a Liferay 809 repository, it may include: <ul> <li> defaultFileEntryTypeId - 810 the file entry type to default all Liferay file entries to </li> 811 <li> dlFileEntryTypesSearchContainerPrimaryKeys - a 812 comma-delimited list of file entry type primary keys allowed in 813 the given folder and all descendants </li> <li> 814 overrideFileEntryTypes - boolean specifying whether to override 815 ancestral folder's restriction of file entry types allowed </li> 816 <li> workflowDefinitionXYZ - the workflow definition name 817 specified per file entry type. The parameter name must be the 818 string <code>workflowDefinition</code> appended by the <code> 819 fileEntryTypeId</code> (optionally <code>0</code>). </li> </ul> 820 * @return the folder 821 * @throws PortalException if the current or new parent folder could not be 822 found, or if the new parent folder's information was invalid 823 * @throws SystemException if a system exception occurred 824 */ 825 public com.liferay.portal.kernel.repository.model.Folder updateFolder( 826 long folderId, long parentFolderId, java.lang.String name, 827 java.lang.String description, 828 com.liferay.portal.service.ServiceContext serviceContext) 829 throws com.liferay.portal.kernel.exception.PortalException, 830 com.liferay.portal.kernel.exception.SystemException { 831 return _dlAppLocalService.updateFolder(folderId, parentFolderId, name, 832 description, serviceContext); 833 } 834 835 /** 836 * @deprecated Renamed to {@link #getWrappedService} 837 */ 838 public DLAppLocalService getWrappedDLAppLocalService() { 839 return _dlAppLocalService; 840 } 841 842 /** 843 * @deprecated Renamed to {@link #setWrappedService} 844 */ 845 public void setWrappedDLAppLocalService(DLAppLocalService dlAppLocalService) { 846 _dlAppLocalService = dlAppLocalService; 847 } 848 849 public DLAppLocalService getWrappedService() { 850 return _dlAppLocalService; 851 } 852 853 public void setWrappedService(DLAppLocalService dlAppLocalService) { 854 _dlAppLocalService = dlAppLocalService; 855 } 856 857 private DLAppLocalService _dlAppLocalService; 858 }