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.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    
024    /**
025     * The interface for the d l app local service.
026     *
027     * <p>
028     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see DLAppLocalServiceUtil
033     * @see com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl
034     * @see com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface DLAppLocalService extends BaseLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link DLAppLocalServiceUtil} to access the d l app local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Returns the Spring bean ID for this bean.
048            *
049            * @return the Spring bean ID for this bean
050            */
051            public java.lang.String getBeanIdentifier();
052    
053            /**
054            * Sets the Spring bean ID for this bean.
055            *
056            * @param beanIdentifier the Spring bean ID for this bean
057            */
058            public void setBeanIdentifier(java.lang.String beanIdentifier);
059    
060            /**
061            * Adds a file entry and associated metadata based on a byte array.
062            *
063            * <p>
064            * This method takes two file names, the <code>sourceFileName</code> and the
065            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
066            * name of the actual file being uploaded. The <code>title</code>
067            * corresponds to a name the client wishes to assign this file after it has
068            * been uploaded to the portal. If it is <code>null</code>, the <code>
069            * sourceFileName</code> will be used.
070            * </p>
071            *
072            * @param userId the primary key of the file entry's creator/owner
073            * @param repositoryId the primary key of the file entry's repository
074            * @param folderId the primary key of the file entry's parent folder
075            * @param sourceFileName the original file's name
076            * @param mimeType the file's MIME type
077            * @param title the name to be assigned to the file (optionally <code>null
078            </code>)
079            * @param description the file's description
080            * @param changeLog the file's version change log
081            * @param bytes the file's data (optionally <code>null</code>)
082            * @param serviceContext the service context to be applied. Can set the
083            asset category IDs, asset tag names, and expando bridge
084            attributes for the file entry. In a Liferay repository, it may
085            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
086            type </li> <li> fieldsMap - mapping for fields associated with a
087            custom file entry type </li> </ul>
088            * @return the file entry
089            * @throws PortalException if the parent folder could not be found or if the
090            file entry's information was invalid
091            * @throws SystemException if a system exception occurred
092            */
093            public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(
094                    long userId, long repositoryId, long folderId,
095                    java.lang.String sourceFileName, java.lang.String mimeType,
096                    java.lang.String title, java.lang.String description,
097                    java.lang.String changeLog, byte[] bytes,
098                    com.liferay.portal.service.ServiceContext serviceContext)
099                    throws com.liferay.portal.kernel.exception.PortalException,
100                            com.liferay.portal.kernel.exception.SystemException;
101    
102            /**
103            * Adds a file entry and associated metadata based on a {@link java.io.File}
104            * object.
105            *
106            * <p>
107            * This method takes two file names, the <code>sourceFileName</code> and the
108            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
109            * name of the actual file being uploaded. The <code>title</code>
110            * corresponds to a name the client wishes to assign this file after it has
111            * been uploaded to the portal. If it is <code>null</code>, the <code>
112            * sourceFileName</code> will be used.
113            * </p>
114            *
115            * @param userId the primary key of the file entry's creator/owner
116            * @param repositoryId the primary key of the repository
117            * @param folderId the primary key of the file entry's parent folder
118            * @param sourceFileName the original file's name
119            * @param mimeType the file's MIME type
120            * @param title the name to be assigned to the file (optionally <code>null
121            </code>)
122            * @param description the file's description
123            * @param changeLog the file's version change log
124            * @param file the file's data (optionally <code>null</code>)
125            * @param serviceContext the service context to be applied. Can set the
126            asset category IDs, asset tag names, and expando bridge
127            attributes for the file entry. In a Liferay repository, it may
128            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
129            type </li> <li> fieldsMap - mapping for fields associated with a
130            custom file entry type </li> </ul>
131            * @return the file entry
132            * @throws PortalException if the parent folder could not be found or if the
133            file entry's information was invalid
134            * @throws SystemException if a system exception occurred
135            */
136            public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(
137                    long userId, long repositoryId, long folderId,
138                    java.lang.String sourceFileName, java.lang.String mimeType,
139                    java.lang.String title, java.lang.String description,
140                    java.lang.String changeLog, java.io.File file,
141                    com.liferay.portal.service.ServiceContext serviceContext)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
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    
189            /**
190            * Adds the file rank to the existing file entry. This method is only
191            * supported by the Liferay repository.
192            *
193            * @param repositoryId the primary key of the repository
194            * @param companyId the primary key of the company
195            * @param userId the primary key of the file rank's creator/owner
196            * @param fileEntryId the primary key of the file entry
197            * @param serviceContext the service context to be applied
198            * @return the file rank
199            * @throws PortalException if a portal exception occurred
200            * @throws SystemException if a system exception occurred
201            */
202            public com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(
203                    long repositoryId, long companyId, long userId, long fileEntryId,
204                    com.liferay.portal.service.ServiceContext serviceContext)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Adds the file shortcut to the existing file entry. This method is only
210            * supported by the Liferay repository.
211            *
212            * @param userId the primary key of the file shortcut's creator/owner
213            * @param repositoryId the primary key of the repository
214            * @param folderId the primary key of the file shortcut's parent folder
215            * @param toFileEntryId the primary key of the file entry to point to
216            * @param serviceContext the service context to be applied. Can set the
217            asset category IDs, asset tag names, and expando bridge
218            attributes for the file entry.
219            * @return the file shortcut
220            * @throws PortalException if the parent folder or file entry could not be
221            found, or if the file shortcut's information was invalid
222            * @throws SystemException if a system exception occurred
223            */
224            public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
225                    long userId, long repositoryId, long folderId, long toFileEntryId,
226                    com.liferay.portal.service.ServiceContext serviceContext)
227                    throws com.liferay.portal.kernel.exception.PortalException,
228                            com.liferay.portal.kernel.exception.SystemException;
229    
230            /**
231            * Adds a folder.
232            *
233            * @param userId the primary key of the folder's creator/owner
234            * @param repositoryId the primary key of the repository
235            * @param parentFolderId the primary key of the folder's parent folder
236            * @param name the folder's name
237            * @param description the folder's description
238            * @param serviceContext the service context to be applied. In a Liferay
239            repository, it may include mountPoint which is a boolean
240            specifying whether the folder is a facade for mounting a
241            third-party repository
242            * @return the folder
243            * @throws PortalException if the parent folder could not be found or if the
244            new folder's information was invalid
245            * @throws SystemException if a system exception occurred
246            */
247            public com.liferay.portal.kernel.repository.model.Folder addFolder(
248                    long userId, long repositoryId, long parentFolderId,
249                    java.lang.String name, java.lang.String description,
250                    com.liferay.portal.service.ServiceContext serviceContext)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            /**
255            * Delete all data associated to the given repository. This method is only
256            * supported by the Liferay repository.
257            *
258            * @param repositoryId the primary key of the data's repository
259            * @throws PortalException if the repository could not be found
260            * @throws SystemException if a system exception occurred
261            */
262            public void deleteAll(long repositoryId)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            /**
267            * Deletes the file entry.
268            *
269            * @param fileEntryId the primary key of the file entry
270            * @throws PortalException if the file entry could not be found
271            * @throws SystemException if a system exception occurred
272            */
273            public void deleteFileEntry(long fileEntryId)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            /**
278            * Deletes the file ranks associated to a given file entry. This method is
279            * only supported by the Liferay repository.
280            *
281            * @param fileEntryId the primary key of the file entry
282            * @throws SystemException if a system exception occurred
283            */
284            public void deleteFileRanksByFileEntryId(long fileEntryId)
285                    throws com.liferay.portal.kernel.exception.SystemException;
286    
287            /**
288            * Deletes the file ranks associated to a given user. This method is only
289            * supported by the Liferay repository.
290            *
291            * @param userId the primary key of the user
292            * @throws SystemException if a system exception occurred
293            */
294            public void deleteFileRanksByUserId(long userId)
295                    throws com.liferay.portal.kernel.exception.SystemException;
296    
297            /**
298            * Deletes the file shortcut. This method is only supported by the Liferay
299            * repository.
300            *
301            * @param dlFileShortcut the file shortcut
302            * @throws PortalException if the file shortcut could not be found
303            * @throws SystemException if a system exception occurred
304            */
305            public void deleteFileShortcut(
306                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException;
309    
310            /**
311            * Deletes the file shortcut. This method is only supported by the Liferay
312            * repository.
313            *
314            * @param fileShortcutId the primary key of the file shortcut
315            * @throws PortalException if the file shortcut could not be found
316            * @throws SystemException if a system exception occurred
317            */
318            public void deleteFileShortcut(long fileShortcutId)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            /**
323            * Deletes all file shortcuts associated to the file entry. This method is
324            * only supported by the Liferay repository.
325            *
326            * @param toFileEntryId the primary key of the associated file entry
327            * @throws PortalException if the file shortcut for the file entry could not
328            be found
329            * @throws SystemException if a system exception occurred
330            */
331            public void deleteFileShortcuts(long toFileEntryId)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException;
334    
335            /**
336            * Deletes the folder and all of its subfolders and file entries.
337            *
338            * @param folderId the primary key of the folder
339            * @throws PortalException if the folder could not be found
340            * @throws SystemException if a system exception occurred
341            */
342            public void deleteFolder(long folderId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    
346            /**
347            * Returns the file entry with the primary key.
348            *
349            * @param fileEntryId the primary key of the file entry
350            * @return the file entry with the primary key
351            * @throws PortalException if the file entry could not be found
352            * @throws SystemException if a system exception occurred
353            */
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(
356                    long fileEntryId)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException;
359    
360            /**
361            * Returns the file entry with the title in the folder.
362            *
363            * @param groupId the primary key of the file entry's group
364            * @param folderId the primary key of the file entry's folder
365            * @param title the file entry's title
366            * @return the file entry with the title in the folder
367            * @throws PortalException if the file entry could not be found
368            * @throws SystemException if a system exception occurred
369            */
370            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
371            public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(
372                    long groupId, long folderId, java.lang.String title)
373                    throws com.liferay.portal.kernel.exception.PortalException,
374                            com.liferay.portal.kernel.exception.SystemException;
375    
376            /**
377            * Returns the file entry with the UUID and group.
378            *
379            * @param uuid the file entry's UUID
380            * @param groupId the primary key of the file entry's group
381            * @return the file entry with the UUID and group
382            * @throws PortalException if the file entry could not be found
383            * @throws SystemException if a system exception occurred
384            */
385            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
386            public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId(
387                    java.lang.String uuid, long groupId)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException;
390    
391            /**
392            * Returns the file ranks from the user. This method is only supported by
393            * the Liferay repository.
394            *
395            * @param repositoryId the primary key of the repository
396            * @param userId the primary key of the user
397            * @return the file ranks from the user
398            * @throws SystemException if a system exception occurred
399            */
400            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(
402                    long repositoryId, long userId)
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            /**
406            * Returns the file shortcut with the primary key. This method is only
407            * supported by the Liferay repository.
408            *
409            * @param fileShortcutId the primary key of the file shortcut
410            * @return the file shortcut with the primary key
411            * @throws PortalException if the file shortcut could not be found
412            * @throws SystemException if a system exception occurred
413            */
414            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
415            public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
416                    long fileShortcutId)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    
420            /**
421            * Returns the file version with the primary key.
422            *
423            * @param fileVersionId the primary key of the file version
424            * @return the file version with the primary key
425            * @throws PortalException if the file version could not be found
426            * @throws SystemException if a system exception occurred
427            */
428            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
429            public com.liferay.portal.kernel.repository.model.FileVersion getFileVersion(
430                    long fileVersionId)
431                    throws com.liferay.portal.kernel.exception.PortalException,
432                            com.liferay.portal.kernel.exception.SystemException;
433    
434            /**
435            * Returns the folder with the primary key.
436            *
437            * @param folderId the primary key of the folder
438            * @return the folder with the primary key
439            * @throws PortalException if the folder could not be found
440            * @throws SystemException if a system exception occurred
441            */
442            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
443            public com.liferay.portal.kernel.repository.model.Folder getFolder(
444                    long folderId)
445                    throws com.liferay.portal.kernel.exception.PortalException,
446                            com.liferay.portal.kernel.exception.SystemException;
447    
448            /**
449            * Returns the folder with the name in the parent folder.
450            *
451            * @param repositoryId the primary key of the folder's repository
452            * @param parentFolderId the primary key of the folder's parent folder
453            * @param name the folder's name
454            * @return the folder with the name in the parent folder
455            * @throws PortalException if the folder could not be found
456            * @throws SystemException if a system exception occurred
457            */
458            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
459            public com.liferay.portal.kernel.repository.model.Folder getFolder(
460                    long repositoryId, long parentFolderId, java.lang.String name)
461                    throws com.liferay.portal.kernel.exception.PortalException,
462                            com.liferay.portal.kernel.exception.SystemException;
463    
464            /**
465            * Returns the mount folder of the repository with the primary key. This
466            * method is only supported by the Liferay repository.
467            *
468            * @param repositoryId the primary key of the repository
469            * @return the folder used for mounting third-party repositories
470            * @throws PortalException if the repository or mount folder could not be
471            found
472            * @throws SystemException if a system exception occurred
473            */
474            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
475            public com.liferay.portal.kernel.repository.model.Folder getMountFolder(
476                    long repositoryId)
477                    throws com.liferay.portal.kernel.exception.PortalException,
478                            com.liferay.portal.kernel.exception.SystemException;
479    
480            /**
481            * Moves the file entry to the new folder.
482            *
483            * @param userId the primary key of the user
484            * @param fileEntryId the primary key of the file entry
485            * @param newFolderId the primary key of the new folder
486            * @param serviceContext the service context to be applied
487            * @return the file entry
488            * @throws PortalException if the file entry or the new folder could not be
489            found
490            * @throws SystemException if a system exception occurred
491            */
492            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry(
493                    long userId, long fileEntryId, long newFolderId,
494                    com.liferay.portal.service.ServiceContext serviceContext)
495                    throws com.liferay.portal.kernel.exception.PortalException,
496                            com.liferay.portal.kernel.exception.SystemException;
497    
498            /**
499            * Moves the file entry with the primary key to the trash portlet.
500            *
501            * @param userId the primary key of the user
502            * @param fileEntryId the primary key of the file entry
503            * @throws PortalException if the file entry could not be found
504            * @throws SystemException if a system exception occurred
505            */
506            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash(
507                    long userId, long fileEntryId)
508                    throws com.liferay.portal.kernel.exception.PortalException,
509                            com.liferay.portal.kernel.exception.SystemException;
510    
511            /**
512            * Restores the file entry with the primary key from the trash portlet.
513            *
514            * @param userId the primary key of the user
515            * @param fileEntryId the primary key of the file entry
516            * @throws PortalException if the file entry could not be found
517            * @throws SystemException if a system exception occurred
518            */
519            public void restoreFileEntryFromTrash(long userId, long fileEntryId)
520                    throws com.liferay.portal.kernel.exception.PortalException,
521                            com.liferay.portal.kernel.exception.SystemException;
522    
523            /**
524            * Subscribe the user to changes in documents of the file entry type. This
525            * method is only supported by the Liferay repository.
526            *
527            * @param userId the primary key of the user
528            * @param groupId the primary key of the file entry type's group
529            * @param fileEntryTypeId the primary key of the file entry type
530            * @throws PortalException if the user or group could not be found
531            * @throws SystemException if a system exception occurred
532            */
533            public void subscribeFileEntryType(long userId, long groupId,
534                    long fileEntryTypeId)
535                    throws com.liferay.portal.kernel.exception.PortalException,
536                            com.liferay.portal.kernel.exception.SystemException;
537    
538            /**
539            * Subscribe the user to document changes in the folder. This method is only
540            * supported by the Liferay repository.
541            *
542            * @param userId the primary key of the user
543            * @param groupId the primary key of the folder's group
544            * @param folderId the primary key of the folder
545            * @throws PortalException if the user or group could not be found
546            * @throws SystemException if a system exception occurred
547            */
548            public void subscribeFolder(long userId, long groupId, long folderId)
549                    throws com.liferay.portal.kernel.exception.PortalException,
550                            com.liferay.portal.kernel.exception.SystemException;
551    
552            /**
553            * Unsubscribe the user from changes in documents of the file entry type.
554            * This method is only supported by the Liferay repository.
555            *
556            * @param userId the primary key of the user
557            * @param groupId the primary key of the file entry type's group
558            * @param fileEntryTypeId the primary key of the file entry type
559            * @throws PortalException if the user or group could not be found
560            * @throws SystemException if a system exception occurred
561            */
562            public void unsubscribeFileEntryType(long userId, long groupId,
563                    long fileEntryTypeId)
564                    throws com.liferay.portal.kernel.exception.PortalException,
565                            com.liferay.portal.kernel.exception.SystemException;
566    
567            /**
568            * Unsubscribe the user from document changes in the folder. This method is
569            * only supported by the Liferay repository.
570            *
571            * @param userId the primary key of the user
572            * @param groupId the primary key of the folder's group
573            * @param folderId the primary key of the folder
574            * @throws PortalException if the user or group could not be found
575            * @throws SystemException if a system exception occurred
576            */
577            public void unsubscribeFolder(long userId, long groupId, long folderId)
578                    throws com.liferay.portal.kernel.exception.PortalException,
579                            com.liferay.portal.kernel.exception.SystemException;
580    
581            /**
582            * Updates the file entry's asset replacing its asset categories, tags, and
583            * links.
584            *
585            * @param userId the primary key of the user
586            * @param fileEntry the file entry to update
587            * @param fileVersion the file version to update
588            * @param assetCategoryIds the primary keys of the new asset categories
589            * @param assetTagNames the new asset tag names
590            * @param assetLinkEntryIds the primary keys of the new asset link entries
591            * @throws PortalException if the file entry or version could not be found
592            * @throws SystemException if a system exception occurred
593            */
594            public void updateAsset(long userId,
595                    com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
596                    com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
597                    long[] assetCategoryIds, java.lang.String[] assetTagNames,
598                    long[] assetLinkEntryIds)
599                    throws com.liferay.portal.kernel.exception.PortalException,
600                            com.liferay.portal.kernel.exception.SystemException;
601    
602            /**
603            * Updates a file entry and associated metadata based on a byte array
604            * object. If the file data is <code>null</code>, then only the associated
605            * metadata (i.e., <code>title</code>, <code>description</code>, and
606            * parameters in the <code>serviceContext</code>) will be updated.
607            *
608            * <p>
609            * This method takes two file names, the <code>sourceFileName</code> and the
610            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
611            * name of the actual file being uploaded. The <code>title</code>
612            * corresponds to a name the client wishes to assign this file after it has
613            * been uploaded to the portal.
614            * </p>
615            *
616            * @param userId the primary key of the user
617            * @param fileEntryId the primary key of the file entry
618            * @param sourceFileName the original file's name (optionally
619            <code>null</code>)
620            * @param mimeType the file's MIME type (optionally <code>null</code>)
621            * @param title the new name to be assigned to the file (optionally <code>
622            <code>null</code></code>)
623            * @param description the file's new description
624            * @param changeLog the file's version change log (optionally
625            <code>null</code>)
626            * @param majorVersion whether the new file version is a major version
627            * @param bytes the file's data (optionally <code>null</code>)
628            * @param serviceContext the service context to be applied. Can set the
629            asset category IDs, asset tag names, and expando bridge
630            attributes for the file entry. In a Liferay repository, it may
631            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
632            type </li> <li> fieldsMap - mapping for fields associated with a
633            custom file entry type </li> </ul>
634            * @return the file entry
635            * @throws PortalException if the file entry could not be found
636            * @throws SystemException if a system exception occurred
637            */
638            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(
639                    long userId, long fileEntryId, java.lang.String sourceFileName,
640                    java.lang.String mimeType, java.lang.String title,
641                    java.lang.String description, java.lang.String changeLog,
642                    boolean majorVersion, byte[] bytes,
643                    com.liferay.portal.service.ServiceContext serviceContext)
644                    throws com.liferay.portal.kernel.exception.PortalException,
645                            com.liferay.portal.kernel.exception.SystemException;
646    
647            /**
648            * Updates a file entry and associated metadata based on a {@link
649            * java.io.File} object. If the file data is <code>null</code>, then only
650            * the associated metadata (i.e., <code>title</code>,
651            * <code>description</code>, and parameters in the
652            * <code>serviceContext</code>) will be updated.
653            *
654            * <p>
655            * This method takes two file names, the <code>sourceFileName</code> and the
656            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
657            * name of the actual file being uploaded. The <code>title</code>
658            * corresponds to a name the client wishes to assign this file after it has
659            * been uploaded to the portal.
660            * </p>
661            *
662            * @param userId the primary key of the user
663            * @param fileEntryId the primary key of the file entry
664            * @param sourceFileName the original file's name (optionally
665            <code>null</code>)
666            * @param mimeType the file's MIME type (optionally <code>null</code>)
667            * @param title the new name to be assigned to the file (optionally <code>
668            <code>null</code></code>)
669            * @param description the file's new description
670            * @param changeLog the file's version change log (optionally
671            <code>null</code>)
672            * @param majorVersion whether the new file version is a major version
673            * @param file EntryId the primary key of the file entry
674            * @param serviceContext the service context to be applied. Can set the
675            asset category IDs, asset tag names, and expando bridge
676            attributes for the file entry. In a Liferay repository, it may
677            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
678            type </li> <li> fieldsMap - mapping for fields associated with a
679            custom file entry type </li> </ul>
680            * @return the file entry
681            * @throws PortalException if the file entry could not be found
682            * @throws SystemException if a system exception occurred
683            */
684            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(
685                    long userId, long fileEntryId, java.lang.String sourceFileName,
686                    java.lang.String mimeType, java.lang.String title,
687                    java.lang.String description, java.lang.String changeLog,
688                    boolean majorVersion, java.io.File file,
689                    com.liferay.portal.service.ServiceContext serviceContext)
690                    throws com.liferay.portal.kernel.exception.PortalException,
691                            com.liferay.portal.kernel.exception.SystemException;
692    
693            /**
694            * Updates a file entry and associated metadata based on an {@link java.io.
695            * InputStream} object. If the file data is <code>null</code>, then only the
696            * associated metadata (i.e., <code>title</code>, <code>description</code>,
697            * and parameters in the <code>serviceContext</code>) will be updated.
698            *
699            * <p>
700            * This method takes two file names, the <code>sourceFileName</code> and the
701            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
702            * name of the actual file being uploaded. The <code>title</code>
703            * corresponds to a name the client wishes to assign this file after it has
704            * been uploaded to the portal.
705            * </p>
706            *
707            * @param userId the primary key of the user
708            * @param fileEntryId the primary key of the file entry
709            * @param sourceFileName the original file's name (optionally
710            <code>null</code>)
711            * @param mimeType the file's MIME type (optionally <code>null</code>)
712            * @param title the new name to be assigned to the file (optionally <code>
713            <code>null</code></code>)
714            * @param description the file's new description
715            * @param changeLog the file's version change log (optionally
716            <code>null</code>)
717            * @param majorVersion whether the new file version is a major version
718            * @param is the file's data (optionally <code>null</code>)
719            * @param size the file's size (optionally <code>0</code>)
720            * @param serviceContext the service context to be applied. Can set the
721            asset category IDs, asset tag names, and expando bridge
722            attributes for the file entry. In a Liferay repository, it may
723            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
724            type </li> <li> fieldsMap - mapping for fields associated with a
725            custom file entry type </li> </ul>
726            * @return the file entry
727            * @throws PortalException if the file entry could not be found
728            * @throws SystemException if a system exception occurred
729            */
730            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(
731                    long userId, long fileEntryId, java.lang.String sourceFileName,
732                    java.lang.String mimeType, java.lang.String title,
733                    java.lang.String description, java.lang.String changeLog,
734                    boolean majorVersion, java.io.InputStream is, long size,
735                    com.liferay.portal.service.ServiceContext serviceContext)
736                    throws com.liferay.portal.kernel.exception.PortalException,
737                            com.liferay.portal.kernel.exception.SystemException;
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 PortalException if a portal exception occurred
750            * @throws SystemException if a system exception occurred
751            */
752            public com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(
753                    long repositoryId, long companyId, long userId, long fileEntryId,
754                    com.liferay.portal.service.ServiceContext serviceContext)
755                    throws com.liferay.portal.kernel.exception.PortalException,
756                            com.liferay.portal.kernel.exception.SystemException;
757    
758            /**
759            * Updates a file shortcut to the existing file entry. This method is only
760            * supported by the Liferay repository.
761            *
762            * @param userId the primary key of the file shortcut's creator/owner
763            * @param fileShortcutId the primary key of the file shortcut
764            * @param folderId the primary key of the file shortcut's parent folder
765            * @param toFileEntryId the primary key of the file shortcut's file entry
766            * @param serviceContext the service context to be applied. Can set the
767            asset category IDs, asset tag names, and expando bridge
768            attributes for the file entry.
769            * @return the file shortcut
770            * @throws PortalException if the file shortcut, folder, or file entry could
771            not be found
772            * @throws SystemException if a system exception occurred
773            */
774            public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
775                    long userId, long fileShortcutId, long folderId, long toFileEntryId,
776                    com.liferay.portal.service.ServiceContext serviceContext)
777                    throws com.liferay.portal.kernel.exception.PortalException,
778                            com.liferay.portal.kernel.exception.SystemException;
779    
780            /**
781            * Updates all file shortcuts to the existing file entry to the new file
782            * entry. This method is only supported by the Liferay repository.
783            *
784            * @param toRepositoryId the primary key of the repository
785            * @param oldToFileEntryId the primary key of the old file entry pointed to
786            * @param newToFileEntryId the primary key of the new file entry to point
787            to
788            * @throws SystemException if a system exception occurred
789            */
790            public void updateFileShortcuts(long toRepositoryId, long oldToFileEntryId,
791                    long newToFileEntryId)
792                    throws com.liferay.portal.kernel.exception.SystemException;
793    
794            /**
795            * Updates the folder.
796            *
797            * @param folderId the primary key of the folder
798            * @param parentFolderId the primary key of the folder's new parent folder
799            * @param name the folder's new name
800            * @param description the folder's new description
801            * @param serviceContext the service context to be applied. In a Liferay
802            repository, it may include:  <ul> <li> defaultFileEntryTypeId -
803            the file entry type to default all Liferay file entries to </li>
804            <li> dlFileEntryTypesSearchContainerPrimaryKeys - a
805            comma-delimited list of file entry type primary keys allowed in
806            the given folder and all descendants </li> <li>
807            overrideFileEntryTypes - boolean specifying whether to override
808            ancestral folder's restriction of file entry types allowed </li>
809            <li> workflowDefinitionXYZ - the workflow definition name
810            specified per file entry type. The parameter name must be the
811            string <code>workflowDefinition</code> appended by the <code>
812            fileEntryTypeId</code> (optionally <code>0</code>). </li> </ul>
813            * @return the folder
814            * @throws PortalException if the current or new parent folder could not be
815            found, or if the new parent folder's information was invalid
816            * @throws SystemException if a system exception occurred
817            */
818            public com.liferay.portal.kernel.repository.model.Folder updateFolder(
819                    long folderId, long parentFolderId, java.lang.String name,
820                    java.lang.String description,
821                    com.liferay.portal.service.ServiceContext serviceContext)
822                    throws com.liferay.portal.kernel.exception.PortalException,
823                            com.liferay.portal.kernel.exception.SystemException;
824    }