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 DLAppService}.
022     * </p>
023     *
024     * @author    Brian Wing Shun Chan
025     * @see       DLAppService
026     * @generated
027     */
028    public class DLAppServiceWrapper implements DLAppService,
029            ServiceWrapper<DLAppService> {
030            public DLAppServiceWrapper(DLAppService dlAppService) {
031                    _dlAppService = dlAppService;
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 _dlAppService.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                    _dlAppService.setBeanIdentifier(beanIdentifier);
050            }
051    
052            /**
053            * Adds a file entry and associated metadata. It is created based on a byte
054            * array.
055            *
056            * <p>
057            * This method takes two file names, the <code>sourceFileName</code> and the
058            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
059            * name of the actual file being uploaded. The <code>title</code>
060            * corresponds to a name the client wishes to assign this file after it has
061            * been uploaded to the portal. If it is <code>null</code>, the <code>
062            * sourceFileName</code> will be used.
063            * </p>
064            *
065            * @param repositoryId the primary key of the 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 repositoryId, long folderId, java.lang.String sourceFileName,
087                    java.lang.String mimeType, java.lang.String title,
088                    java.lang.String description, java.lang.String changeLog, byte[] bytes,
089                    com.liferay.portal.service.ServiceContext serviceContext)
090                    throws com.liferay.portal.kernel.exception.PortalException,
091                            com.liferay.portal.kernel.exception.SystemException {
092                    return _dlAppService.addFileEntry(repositoryId, folderId,
093                            sourceFileName, mimeType, title, description, changeLog, bytes,
094                            serviceContext);
095            }
096    
097            /**
098            * Adds a file entry and associated metadata. It is created based on a
099            * {@link java.io.File} object.
100            *
101            * <p>
102            * This method takes two file names, the <code>sourceFileName</code> and the
103            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
104            * name of the actual file being uploaded. The <code>title</code>
105            * corresponds to a name the client wishes to assign this file after it has
106            * been uploaded to the portal. If it is <code>null</code>, the <code>
107            * sourceFileName</code> will be used.
108            * </p>
109            *
110            * @param repositoryId the primary key of the repository
111            * @param folderId the primary key of the file entry's parent folder
112            * @param sourceFileName the original file's name
113            * @param mimeType the file's MIME type
114            * @param title the name to be assigned to the file (optionally <code>null
115            </code>)
116            * @param description the file's description
117            * @param changeLog the file's version change log
118            * @param file the file's data (optionally <code>null</code>)
119            * @param serviceContext the service context to be applied. Can set the
120            asset category IDs, asset tag names, and expando bridge
121            attributes for the file entry. In a Liferay repository, it may
122            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
123            type </li> <li> fieldsMap - mapping for fields associated with a
124            custom file entry type </li> </ul>
125            * @return the file entry
126            * @throws PortalException if the parent folder could not be found or if the
127            file entry's information was invalid
128            * @throws SystemException if a system exception occurred
129            */
130            public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(
131                    long repositoryId, long folderId, java.lang.String sourceFileName,
132                    java.lang.String mimeType, java.lang.String title,
133                    java.lang.String description, java.lang.String changeLog,
134                    java.io.File file,
135                    com.liferay.portal.service.ServiceContext serviceContext)
136                    throws com.liferay.portal.kernel.exception.PortalException,
137                            com.liferay.portal.kernel.exception.SystemException {
138                    return _dlAppService.addFileEntry(repositoryId, folderId,
139                            sourceFileName, mimeType, title, description, changeLog, file,
140                            serviceContext);
141            }
142    
143            /**
144            * Adds a file entry and associated metadata. It is created based on a
145            * {@link java.io.InputStream} object.
146            *
147            * <p>
148            * This method takes two file names, the <code>sourceFileName</code> and the
149            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
150            * name of the actual file being uploaded. The <code>title</code>
151            * corresponds to a name the client wishes to assign this file after it has
152            * been uploaded to the portal. If it is <code>null</code>, the <code>
153            * sourceFileName</code> will be used.
154            * </p>
155            *
156            * @param repositoryId the primary key of the repository
157            * @param folderId the primary key of the file entry's parent folder
158            * @param sourceFileName the original file's name
159            * @param mimeType the file's MIME type
160            * @param title the name to be assigned to the file (optionally <code>null
161            </code>)
162            * @param description the file's description
163            * @param changeLog the file's version change log
164            * @param is the file's data (optionally <code>null</code>)
165            * @param size the file's size (optionally <code>0</code>)
166            * @param serviceContext the service context to be applied. Can set the
167            asset category IDs, asset tag names, and expando bridge
168            attributes for the file entry. In a Liferay repository, it may
169            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
170            type </li> <li> fieldsMap - mapping for fields associated with a
171            custom file entry type </li> </ul>
172            * @return the file entry
173            * @throws PortalException if the parent folder could not be found or if the
174            file entry's information was invalid
175            * @throws SystemException if a system exception occurred
176            */
177            public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(
178                    long repositoryId, long folderId, java.lang.String sourceFileName,
179                    java.lang.String mimeType, java.lang.String title,
180                    java.lang.String description, java.lang.String changeLog,
181                    java.io.InputStream is, long size,
182                    com.liferay.portal.service.ServiceContext serviceContext)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return _dlAppService.addFileEntry(repositoryId, folderId,
186                            sourceFileName, mimeType, title, description, changeLog, is, size,
187                            serviceContext);
188            }
189    
190            /**
191            * Adds a file shortcut to the existing file entry. This method is only
192            * supported by the Liferay repository.
193            *
194            * @param repositoryId the primary key of the repository
195            * @param folderId the primary key of the file shortcut's parent folder
196            * @param toFileEntryId the primary key of the file shortcut's file entry
197            * @param serviceContext the service context to be applied. Can set the
198            asset category IDs, asset tag names, and expando bridge
199            attributes for the file entry.
200            * @return the file shortcut
201            * @throws PortalException if the parent folder or file entry could not be
202            found, or if the file shortcut's information was invalid
203            * @throws SystemException if a system exception occurred
204            */
205            public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
206                    long repositoryId, long folderId, long toFileEntryId,
207                    com.liferay.portal.service.ServiceContext serviceContext)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException {
210                    return _dlAppService.addFileShortcut(repositoryId, folderId,
211                            toFileEntryId, serviceContext);
212            }
213    
214            /**
215            * Adds a folder.
216            *
217            * @param repositoryId the primary key of the repository
218            * @param parentFolderId the primary key of the folder's parent folder
219            * @param name the folder's name
220            * @param description the folder's description
221            * @param serviceContext the service context to be applied. In a Liferay
222            repository, it may include boolean mountPoint specifying whether
223            folder is a facade for mounting a third-party repository
224            * @return the folder
225            * @throws PortalException if the parent folder could not be found or if the
226            new folder's information was invalid
227            * @throws SystemException if a system exception occurred
228            */
229            public com.liferay.portal.kernel.repository.model.Folder addFolder(
230                    long repositoryId, long parentFolderId, java.lang.String name,
231                    java.lang.String description,
232                    com.liferay.portal.service.ServiceContext serviceContext)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException {
235                    return _dlAppService.addFolder(repositoryId, parentFolderId, name,
236                            description, serviceContext);
237            }
238    
239            /**
240            * Adds a temporary file entry.
241            *
242            * <p>
243            * This allows a client to upload a file into a temporary location and
244            * manipulate its metadata prior to making it available for public usage.
245            * This is different from checking in and checking out a file entry.
246            * </p>
247            *
248            * @param groupId the primary key of the group
249            * @param folderId the primary key of the folder where the file entry will
250            eventually reside
251            * @param fileName the file's original name
252            * @param tempFolderName the temporary folder's name
253            * @param file Name the file's original name
254            * @param mimeType the file's MIME type
255            * @return the file's name
256            * @throws PortalException if the file name was invalid
257            * @throws SystemException if a system exception occurred
258            * @see com.liferay.portal.kernel.util.TempFileUtil
259            */
260            public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry(
261                    long groupId, long folderId, java.lang.String fileName,
262                    java.lang.String tempFolderName, java.io.File file,
263                    java.lang.String mimeType)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException {
266                    return _dlAppService.addTempFileEntry(groupId, folderId, fileName,
267                            tempFolderName, file, mimeType);
268            }
269    
270            public com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry(
271                    long groupId, long folderId, java.lang.String fileName,
272                    java.lang.String tempFolderName, java.io.InputStream inputStream,
273                    java.lang.String mimeType)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return _dlAppService.addTempFileEntry(groupId, folderId, fileName,
277                            tempFolderName, inputStream, mimeType);
278            }
279    
280            /**
281            * Cancels the check out of the file entry. If a user has not checked out
282            * the specified file entry, invoking this method will result in no changes.
283            *
284            * <p>
285            * When a file entry is checked out, a PWC (private working copy) is created
286            * and the original file entry is locked. A client can make as many changes
287            * to the PWC as he desires without those changes being visible to other
288            * users. If the user is satisfied with the changes, he may elect to check
289            * in his changes, resulting in a new file version based on the PWC; the PWC
290            * will be removed and the file entry will be unlocked. If the user is not
291            * satisfied with the changes, he may elect to cancel his check out; this
292            * results in the deletion of the PWC and unlocking of the file entry.
293            * </p>
294            *
295            * @param fileEntryId the primary key of the file entry to cancel the
296            checkout
297            * @throws PortalException if the file entry could not be found
298            * @throws SystemException if a system exception occurred
299            * @see #checkInFileEntry(long, boolean, String, ServiceContext)
300            * @see #checkOutFileEntry(long, ServiceContext)
301            */
302            public void cancelCheckOut(long fileEntryId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    _dlAppService.cancelCheckOut(fileEntryId);
306            }
307    
308            /**
309            * Checks in the file entry. If a user has not checked out the specified
310            * file entry, invoking this method will result in no changes.
311            *
312            * <p>
313            * When a file entry is checked out, a PWC (private working copy) is created
314            * and the original file entry is locked. A client can make as many changes
315            * to the PWC as he desires without those changes being visible to other
316            * users. If the user is satisfied with the changes, he may elect to check
317            * in his changes, resulting in a new file version based on the PWC; the PWC
318            * will be removed and the file entry will be unlocked. If the user is not
319            * satisfied with the changes, he may elect to cancel his check out; this
320            * results in the deletion of the PWC and unlocking of the file entry.
321            * </p>
322            *
323            * @param fileEntryId the primary key of the file entry to check in
324            * @param majorVersion whether the new file version is a major version
325            * @param changeLog the file's version change log
326            * @param serviceContext the service context to be applied
327            * @throws PortalException if the file entry could not be found
328            * @throws SystemException if a system exception occurred
329            * @see #cancelCheckOut(long)
330            * @see #checkOutFileEntry(long, ServiceContext)
331            */
332            public void checkInFileEntry(long fileEntryId, boolean majorVersion,
333                    java.lang.String changeLog,
334                    com.liferay.portal.service.ServiceContext serviceContext)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException {
337                    _dlAppService.checkInFileEntry(fileEntryId, majorVersion, changeLog,
338                            serviceContext);
339            }
340    
341            /**
342            * @deprecated {@link #checkInFileEntry(long, String, ServiceContext)}
343            */
344            public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    _dlAppService.checkInFileEntry(fileEntryId, lockUuid);
348            }
349    
350            /**
351            * Checks in the file entry using the lock's UUID. If a user has not checked
352            * out the specified file entry, invoking this method will result in no
353            * changes. This method is primarily used by WebDAV.
354            *
355            * <p>
356            * When a file entry is checked out, a PWC (private working copy) is created
357            * and the original file entry is locked. A client can make as many changes
358            * to the PWC as he desires without those changes being visible to other
359            * users. If the user is satisfied with the changes, he may elect to check
360            * in his changes, resulting in a new file version based on the PWC; the PWC
361            * will be removed and the file entry will be unlocked. If the user is not
362            * satisfied with the changes, he may elect to cancel his check out; this
363            * results in the deletion of the PWC and unlocking of the file entry.
364            * </p>
365            *
366            * @param fileEntryId the primary key of the file entry to check in
367            * @param lockUuid the lock's UUID
368            * @param serviceContext the service context to be applied
369            * @throws PortalException if the file entry could not be found
370            * @throws SystemException if a system exception occurred
371            * @see #cancelCheckOut(long)
372            * @see #checkOutFileEntry(long, String, long, ServiceContext)
373            */
374            public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid,
375                    com.liferay.portal.service.ServiceContext serviceContext)
376                    throws com.liferay.portal.kernel.exception.PortalException,
377                            com.liferay.portal.kernel.exception.SystemException {
378                    _dlAppService.checkInFileEntry(fileEntryId, lockUuid, serviceContext);
379            }
380    
381            /**
382            * Check out a file entry.
383            *
384            * <p>
385            * When a file entry is checked out, a PWC (private working copy) is created
386            * and the original file entry is locked. A client can make as many changes
387            * to the PWC as he desires without those changes being visible to other
388            * users. If the user is satisfied with the changes, he may elect to check
389            * in his changes, resulting in a new file version based on the PWC; the PWC
390            * will be removed and the file entry will be unlocked. If the user is not
391            * satisfied with the changes, he may elect to cancel his check out; this
392            * results in the deletion of the PWC and unlocking of the file entry.
393            * </p>
394            *
395            * @param fileEntryId the file entry to check out
396            * @param serviceContext the service context to be applied
397            * @throws PortalException if the file entry could not be found
398            * @throws SystemException if a system exception occurred
399            * @see #cancelCheckOut(long)
400            * @see #checkInFileEntry(long, boolean, String, ServiceContext)
401            */
402            public void checkOutFileEntry(long fileEntryId,
403                    com.liferay.portal.service.ServiceContext serviceContext)
404                    throws com.liferay.portal.kernel.exception.PortalException,
405                            com.liferay.portal.kernel.exception.SystemException {
406                    _dlAppService.checkOutFileEntry(fileEntryId, serviceContext);
407            }
408    
409            /**
410            * Checks out the file entry. This method is primarily used by WebDAV.
411            *
412            * <p>
413            * When a file entry is checked out, a PWC (private working copy) is created
414            * and the original file entry is locked. A client can make as many changes
415            * to the PWC as he desires without those changes being visible to other
416            * users. If the user is satisfied with the changes, he may elect to check
417            * in his changes, resulting in a new file version based on the PWC; the PWC
418            * will be removed and the file entry will be unlocked. If the user is not
419            * satisfied with the changes, he may elect to cancel his check out; this
420            * results in the deletion of the PWC and unlocking of the file entry.
421            * </p>
422            *
423            * @param fileEntryId the file entry to check out
424            * @param owner the owner string for the checkout (optionally
425            <code>null</code>)
426            * @param expirationTime the time in milliseconds before the lock expires.
427            If the value is <code>0</code>, the default expiration time will
428            be used from <code>portal.properties>.
429            * @param serviceContext the service context to be applied
430            * @return the file entry
431            * @throws PortalException if the file entry could not be found
432            * @throws SystemException if a system exception occurred
433            * @see #cancelCheckOut(long)
434            * @see #checkInFileEntry(long, String)
435            */
436            public com.liferay.portal.kernel.repository.model.FileEntry checkOutFileEntry(
437                    long fileEntryId, java.lang.String owner, long expirationTime,
438                    com.liferay.portal.service.ServiceContext serviceContext)
439                    throws com.liferay.portal.kernel.exception.PortalException,
440                            com.liferay.portal.kernel.exception.SystemException {
441                    return _dlAppService.checkOutFileEntry(fileEntryId, owner,
442                            expirationTime, serviceContext);
443            }
444    
445            /**
446            * Performs a deep copy of the folder.
447            *
448            * @param repositoryId the primary key of the repository
449            * @param sourceFolderId the primary key of the folder to copy
450            * @param parentFolderId the primary key of the new folder's parent folder
451            * @param name the new folder's name
452            * @param description the new folder's description
453            * @param serviceContext the service context to be applied
454            * @return the folder
455            * @throws PortalException if the source folder or the new parent folder
456            could not be found or if the new folder's information was invalid
457            * @throws SystemException if a system exception occurred
458            */
459            public com.liferay.portal.kernel.repository.model.Folder copyFolder(
460                    long repositoryId, long sourceFolderId, long parentFolderId,
461                    java.lang.String name, java.lang.String description,
462                    com.liferay.portal.service.ServiceContext serviceContext)
463                    throws com.liferay.portal.kernel.exception.PortalException,
464                            com.liferay.portal.kernel.exception.SystemException {
465                    return _dlAppService.copyFolder(repositoryId, sourceFolderId,
466                            parentFolderId, name, description, serviceContext);
467            }
468    
469            /**
470            * Deletes the file entry with the primary key.
471            *
472            * @param fileEntryId the primary key of the file entry
473            * @throws PortalException if the file entry could not be found
474            * @throws SystemException if a system exception occurred
475            */
476            public void deleteFileEntry(long fileEntryId)
477                    throws com.liferay.portal.kernel.exception.PortalException,
478                            com.liferay.portal.kernel.exception.SystemException {
479                    _dlAppService.deleteFileEntry(fileEntryId);
480            }
481    
482            /**
483            * Deletes the file entry with the title in the folder.
484            *
485            * @param repositoryId the primary key of the repository
486            * @param folderId the primary key of the file entry's parent folder
487            * @param title the file entry's title
488            * @throws PortalException if the file entry could not be found
489            * @throws SystemException if a system exception occurred
490            */
491            public void deleteFileEntryByTitle(long repositoryId, long folderId,
492                    java.lang.String title)
493                    throws com.liferay.portal.kernel.exception.PortalException,
494                            com.liferay.portal.kernel.exception.SystemException {
495                    _dlAppService.deleteFileEntryByTitle(repositoryId, folderId, title);
496            }
497    
498            /**
499            * Deletes the file shortcut with the primary key. This method is only
500            * supported by the Liferay repository.
501            *
502            * @param fileShortcutId the primary key of the file shortcut
503            * @throws PortalException if the file shortcut could not be found
504            * @throws SystemException if a system exception occurred
505            */
506            public void deleteFileShortcut(long fileShortcutId)
507                    throws com.liferay.portal.kernel.exception.PortalException,
508                            com.liferay.portal.kernel.exception.SystemException {
509                    _dlAppService.deleteFileShortcut(fileShortcutId);
510            }
511    
512            /**
513            * Deletes the file version. File versions can only be deleted if it is
514            * approved and there are other approved file versions available. This
515            * method is only supported by the Liferay repository.
516            *
517            * @param fileEntryId the primary key of the file entry
518            * @param version the version label of the file version
519            * @throws PortalException if the file version could not be found or invalid
520            * @throws SystemException if a system exception occurred
521            */
522            public void deleteFileVersion(long fileEntryId, java.lang.String version)
523                    throws com.liferay.portal.kernel.exception.PortalException,
524                            com.liferay.portal.kernel.exception.SystemException {
525                    _dlAppService.deleteFileVersion(fileEntryId, version);
526            }
527    
528            /**
529            * Deletes the folder with the primary key and all of its subfolders and
530            * file entries.
531            *
532            * @param folderId the primary key of the folder
533            * @throws PortalException if the folder could not be found
534            * @throws SystemException if a system exception occurred
535            */
536            public void deleteFolder(long folderId)
537                    throws com.liferay.portal.kernel.exception.PortalException,
538                            com.liferay.portal.kernel.exception.SystemException {
539                    _dlAppService.deleteFolder(folderId);
540            }
541    
542            /**
543            * Deletes the folder with the name in the parent folder and all of its
544            * subfolders and file entries.
545            *
546            * @param repositoryId the primary key of the repository
547            * @param parentFolderId the primary key of the folder's parent folder
548            * @param name the folder's name
549            * @throws PortalException if the folder could not be found
550            * @throws SystemException if a system exception occurred
551            */
552            public void deleteFolder(long repositoryId, long parentFolderId,
553                    java.lang.String name)
554                    throws com.liferay.portal.kernel.exception.PortalException,
555                            com.liferay.portal.kernel.exception.SystemException {
556                    _dlAppService.deleteFolder(repositoryId, parentFolderId, name);
557            }
558    
559            /**
560            * Deletes the temporary file entry.
561            *
562            * @param groupId the primary key of the group
563            * @param folderId the primary key of the folder where the file entry was
564            eventually to reside
565            * @param fileName the file's original name
566            * @param tempFolderName the temporary folder's name
567            * @throws PortalException if the file name was invalid
568            * @throws SystemException if a system exception occurred
569            * @see com.liferay.portal.kernel.util.TempFileUtil
570            */
571            public void deleteTempFileEntry(long groupId, long folderId,
572                    java.lang.String fileName, java.lang.String tempFolderName)
573                    throws com.liferay.portal.kernel.exception.PortalException,
574                            com.liferay.portal.kernel.exception.SystemException {
575                    _dlAppService.deleteTempFileEntry(groupId, folderId, fileName,
576                            tempFolderName);
577            }
578    
579            /**
580            * Returns all the file entries in the folder.
581            *
582            * @param repositoryId the primary key of the file entry's repository
583            * @param folderId the primary key of the file entry's folder
584            * @return the file entries in the folder
585            * @throws PortalException if the folder could not be found
586            * @throws SystemException if a system exception occurred
587            */
588            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(
589                    long repositoryId, long folderId)
590                    throws com.liferay.portal.kernel.exception.PortalException,
591                            com.liferay.portal.kernel.exception.SystemException {
592                    return _dlAppService.getFileEntries(repositoryId, folderId);
593            }
594    
595            /**
596            * Returns a range of all the file entries in the folder.
597            *
598            * <p>
599            * Useful when paginating results. Returns a maximum of <code>end -
600            * start</code> instances. <code>start</code> and <code>end</code> are not
601            * primary keys, they are indexes in the result set. Thus, <code>0</code>
602            * refers to the first result in the set. Setting both <code>start</code>
603            * and <code>end</code> to {@link
604            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
605            * result set.
606            * </p>
607            *
608            * @param repositoryId the primary key of the file entry's repository
609            * @param folderId the primary key of the file entry's folder
610            * @param start the lower bound of the range of results
611            * @param end the upper bound of the range of results (not inclusive)
612            * @return the range of file entries in the folder
613            * @throws PortalException if the folder could not be found
614            * @throws SystemException if a system exception occurred
615            */
616            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(
617                    long repositoryId, long folderId, int start, int end)
618                    throws com.liferay.portal.kernel.exception.PortalException,
619                            com.liferay.portal.kernel.exception.SystemException {
620                    return _dlAppService.getFileEntries(repositoryId, folderId, start, end);
621            }
622    
623            /**
624            * Returns an ordered range of all the file entries in the folder.
625            *
626            * <p>
627            * Useful when paginating results. Returns a maximum of <code>end -
628            * start</code> instances. <code>start</code> and <code>end</code> are not
629            * primary keys, they are indexes in the result set. Thus, <code>0</code>
630            * refers to the first result in the set. Setting both <code>start</code>
631            * and <code>end</code> to {@link
632            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
633            * result set.
634            * </p>
635            *
636            * @param repositoryId the primary key of the file entry's repository
637            * @param folderId the primary key of the file entry's folder
638            * @param start the lower bound of the range of results
639            * @param end the upper bound of the range of results (not inclusive)
640            * @param obc the comparator to order the file entries (optionally
641            <code>null</code>)
642            * @return the range of file entries in the folder ordered by comparator
643            <code>obc</code>
644            * @throws PortalException if the folder could not be found
645            * @throws SystemException if a system exception occurred
646            */
647            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(
648                    long repositoryId, long folderId, int start, int end,
649                    com.liferay.portal.kernel.util.OrderByComparator obc)
650                    throws com.liferay.portal.kernel.exception.PortalException,
651                            com.liferay.portal.kernel.exception.SystemException {
652                    return _dlAppService.getFileEntries(repositoryId, folderId, start, end,
653                            obc);
654            }
655    
656            /**
657            * Returns the file entries with the file entry type in the folder.
658            *
659            * @param repositoryId the primary key of the file entry's repository
660            * @param folderId the primary key of the file entry's folder
661            * @param fileEntryTypeId the primary key of the file entry type
662            * @return the file entries with the file entry type in the folder
663            * @throws PortalException if the folder could not be found
664            * @throws SystemException if a system exception occurred
665            */
666            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(
667                    long repositoryId, long folderId, long fileEntryTypeId)
668                    throws com.liferay.portal.kernel.exception.PortalException,
669                            com.liferay.portal.kernel.exception.SystemException {
670                    return _dlAppService.getFileEntries(repositoryId, folderId,
671                            fileEntryTypeId);
672            }
673    
674            /**
675            * Returns a range of all the file entries with the file entry type in the
676            * folder.
677            *
678            * @param repositoryId the primary key of the file entry's repository
679            * @param folderId the primary key of the file entry's folder
680            * @param fileEntryTypeId the primary key of the file entry type
681            * @param start the lower bound of the range of results
682            * @param end the upper bound of the range of results (not inclusive)
683            * @return the file entries in the folder
684            * @throws PortalException if the folder could not be found
685            * @throws SystemException if a system exception occurred
686            */
687            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(
688                    long repositoryId, long folderId, long fileEntryTypeId, int start,
689                    int end)
690                    throws com.liferay.portal.kernel.exception.PortalException,
691                            com.liferay.portal.kernel.exception.SystemException {
692                    return _dlAppService.getFileEntries(repositoryId, folderId,
693                            fileEntryTypeId, start, end);
694            }
695    
696            /**
697            * Returns an ordered range of all the file entries with the file entry type
698            * in the folder.
699            *
700            * @param repositoryId the primary key of the repository
701            * @param folderId the primary key of the folder
702            * @param fileEntryTypeId the primary key of the file entry type
703            * @param start the lower bound of the range of results
704            * @param end the upper bound of the range of results (not inclusive)
705            * @param obc the comparator to order the results by (optionally
706            <code>null</code>)
707            * @return the range of file entries with the file entry type in the folder
708            ordered by <code>null</code>
709            * @throws PortalException if the folder could not be found
710            * @throws SystemException if a system exception occurred
711            */
712            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(
713                    long repositoryId, long folderId, long fileEntryTypeId, int start,
714                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
715                    throws com.liferay.portal.kernel.exception.PortalException,
716                            com.liferay.portal.kernel.exception.SystemException {
717                    return _dlAppService.getFileEntries(repositoryId, folderId,
718                            fileEntryTypeId, start, end, obc);
719            }
720    
721            /**
722            * Returns a range of all the file entries and shortcuts in the folder.
723            *
724            * <p>
725            * Useful when paginating results. Returns a maximum of <code>end -
726            * start</code> instances. <code>start</code> and <code>end</code> are not
727            * primary keys, they are indexes in the result set. Thus, <code>0</code>
728            * refers to the first result in the set. Setting both <code>start</code>
729            * and <code>end</code> to {@link
730            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
731            * result set.
732            * </p>
733            *
734            * @param repositoryId the primary key of the repository
735            * @param folderId the primary key of the folder
736            * @param status the workflow status
737            * @param start the lower bound of the range of results
738            * @param end the upper bound of the range of results (not inclusive)
739            * @return the range of file entries and shortcuts in the folder
740            * @throws PortalException if the folder could not be found
741            * @throws SystemException if a system exception occurred
742            */
743            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
744                    long repositoryId, long folderId, int status, int start, int end)
745                    throws com.liferay.portal.kernel.exception.PortalException,
746                            com.liferay.portal.kernel.exception.SystemException {
747                    return _dlAppService.getFileEntriesAndFileShortcuts(repositoryId,
748                            folderId, status, start, end);
749            }
750    
751            /**
752            * Returns the number of file entries and shortcuts in the folder.
753            *
754            * @param repositoryId the primary key of the repository
755            * @param folderId the primary key of the folder
756            * @param status the workflow status
757            * @return the number of file entries and shortcuts in the folder
758            * @throws PortalException if the folder ould not be found
759            * @throws SystemException if a system exception occurred
760            */
761            public int getFileEntriesAndFileShortcutsCount(long repositoryId,
762                    long folderId, int status)
763                    throws com.liferay.portal.kernel.exception.PortalException,
764                            com.liferay.portal.kernel.exception.SystemException {
765                    return _dlAppService.getFileEntriesAndFileShortcutsCount(repositoryId,
766                            folderId, status);
767            }
768    
769            /**
770            * Returns the number of file entries and shortcuts in the folder.
771            *
772            * @param repositoryId the primary key of the repository
773            * @param folderId the primary key of the folder
774            * @param status the workflow status
775            * @param mimeTypes allowed media types
776            * @return the number of file entries and shortcuts in the folder
777            * @throws PortalException if the folder ould not be found
778            * @throws SystemException if a system exception occurred
779            */
780            public int getFileEntriesAndFileShortcutsCount(long repositoryId,
781                    long folderId, int status, java.lang.String[] mimeTypes)
782                    throws com.liferay.portal.kernel.exception.PortalException,
783                            com.liferay.portal.kernel.exception.SystemException {
784                    return _dlAppService.getFileEntriesAndFileShortcutsCount(repositoryId,
785                            folderId, status, mimeTypes);
786            }
787    
788            /**
789            * Returns the number of file entries in the folder.
790            *
791            * @param repositoryId the primary key of the file entry's repository
792            * @param folderId the primary key of the file entry's folder
793            * @return the number of file entries in the folder
794            * @throws PortalException if the folder could not be found
795            * @throws SystemException if a system exception occurred
796            */
797            public int getFileEntriesCount(long repositoryId, long folderId)
798                    throws com.liferay.portal.kernel.exception.PortalException,
799                            com.liferay.portal.kernel.exception.SystemException {
800                    return _dlAppService.getFileEntriesCount(repositoryId, folderId);
801            }
802    
803            /**
804            * Returns the number of file entries with the file entry type in the
805            * folder.
806            *
807            * @param repositoryId the primary key of the file entry's repository
808            * @param folderId the primary key of the file entry's folder
809            * @param fileEntryTypeId the primary key of the file entry type
810            * @return the number of file entries with the file entry type in the folder
811            * @throws PortalException if the folder could not be found
812            * @throws SystemException if a system exception occurred
813            */
814            public int getFileEntriesCount(long repositoryId, long folderId,
815                    long fileEntryTypeId)
816                    throws com.liferay.portal.kernel.exception.PortalException,
817                            com.liferay.portal.kernel.exception.SystemException {
818                    return _dlAppService.getFileEntriesCount(repositoryId, folderId,
819                            fileEntryTypeId);
820            }
821    
822            /**
823            * Returns the file entry with the primary key.
824            *
825            * @param fileEntryId the primary key of the file entry
826            * @return the file entry with the primary key
827            * @throws PortalException if the file entry could not be found
828            * @throws SystemException if a system exception occurred
829            */
830            public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(
831                    long fileEntryId)
832                    throws com.liferay.portal.kernel.exception.PortalException,
833                            com.liferay.portal.kernel.exception.SystemException {
834                    return _dlAppService.getFileEntry(fileEntryId);
835            }
836    
837            /**
838            * Returns the file entry with the title in the folder.
839            *
840            * @param groupId the primary key of the file entry's group
841            * @param folderId the primary key of the file entry's folder
842            * @param title the file entry's title
843            * @return the file entry with the title in the folder
844            * @throws PortalException if the file entry could not be found
845            * @throws SystemException if a system exception occurred
846            */
847            public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(
848                    long groupId, long folderId, java.lang.String title)
849                    throws com.liferay.portal.kernel.exception.PortalException,
850                            com.liferay.portal.kernel.exception.SystemException {
851                    return _dlAppService.getFileEntry(groupId, folderId, title);
852            }
853    
854            /**
855            * Returns the file entry with the UUID and group.
856            *
857            * @param uuid the file entry's UUID
858            * @param groupId the primary key of the file entry's group
859            * @return the file entry with the UUID and group
860            * @throws PortalException if the file entry could not be found
861            * @throws SystemException if a system exception occurred
862            */
863            public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId(
864                    java.lang.String uuid, long groupId)
865                    throws com.liferay.portal.kernel.exception.PortalException,
866                            com.liferay.portal.kernel.exception.SystemException {
867                    return _dlAppService.getFileEntryByUuidAndGroupId(uuid, groupId);
868            }
869    
870            /**
871            * Returns the file shortcut with the primary key. This method is only
872            * supported by the Liferay repository.
873            *
874            * @param fileShortcutId the primary key of the file shortcut
875            * @return the file shortcut with the primary key
876            * @throws PortalException if the file shortcut could not be found
877            * @throws SystemException if a system exception occurred
878            */
879            public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
880                    long fileShortcutId)
881                    throws com.liferay.portal.kernel.exception.PortalException,
882                            com.liferay.portal.kernel.exception.SystemException {
883                    return _dlAppService.getFileShortcut(fileShortcutId);
884            }
885    
886            /**
887            * Returns the folder with the primary key.
888            *
889            * @param folderId the primary key of the folder
890            * @return the folder with the primary key
891            * @throws PortalException if the folder could not be found
892            * @throws SystemException if a system exception occurred
893            */
894            public com.liferay.portal.kernel.repository.model.Folder getFolder(
895                    long folderId)
896                    throws com.liferay.portal.kernel.exception.PortalException,
897                            com.liferay.portal.kernel.exception.SystemException {
898                    return _dlAppService.getFolder(folderId);
899            }
900    
901            /**
902            * Returns the folder with the name in the parent folder.
903            *
904            * @param repositoryId the primary key of the folder's repository
905            * @param parentFolderId the primary key of the folder's parent folder
906            * @param name the folder's name
907            * @return the folder with the name in the parent folder
908            * @throws PortalException if the folder could not be found
909            * @throws SystemException if a system exception occurred
910            */
911            public com.liferay.portal.kernel.repository.model.Folder getFolder(
912                    long repositoryId, long parentFolderId, java.lang.String name)
913                    throws com.liferay.portal.kernel.exception.PortalException,
914                            com.liferay.portal.kernel.exception.SystemException {
915                    return _dlAppService.getFolder(repositoryId, parentFolderId, name);
916            }
917    
918            /**
919            * Returns all immediate subfolders of the parent folder.
920            *
921            * @param repositoryId the primary key of the folder's repository
922            * @param parentFolderId the primary key of the folder's parent folder
923            * @return the immediate subfolders of the parent folder
924            * @throws PortalException if the parent folder could not be found
925            * @throws SystemException if a system exception occurred
926            */
927            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
928                    long repositoryId, long parentFolderId)
929                    throws com.liferay.portal.kernel.exception.PortalException,
930                            com.liferay.portal.kernel.exception.SystemException {
931                    return _dlAppService.getFolders(repositoryId, parentFolderId);
932            }
933    
934            /**
935            * Returns all immediate subfolders of the parent folder, optionally
936            * including mount folders for third-party repositories.
937            *
938            * @param repositoryId the primary key of the folder's repository
939            * @param parentFolderId the primary key of the folder's parent folder
940            * @param includeMountFolders whether to include mount folders for
941            third-party repositories
942            * @return the immediate subfolders of the parent folder
943            * @throws PortalException if the parent folder could not be found
944            * @throws SystemException if a system exception occurred
945            */
946            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
947                    long repositoryId, long parentFolderId, boolean includeMountFolders)
948                    throws com.liferay.portal.kernel.exception.PortalException,
949                            com.liferay.portal.kernel.exception.SystemException {
950                    return _dlAppService.getFolders(repositoryId, parentFolderId,
951                            includeMountFolders);
952            }
953    
954            /**
955            * Returns a range of all the immediate subfolders of the parent folder,
956            * optionally including mount folders for third-party repositories.
957            *
958            * <p>
959            * Useful when paginating results. Returns a maximum of <code>end -
960            * start</code> instances. <code>start</code> and <code>end</code> are not
961            * primary keys, they are indexes in the result set. Thus, <code>0</code>
962            * refers to the first result in the set. Setting both <code>start</code>
963            * and <code>end</code> to {@link
964            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
965            * result set.
966            * </p>
967            *
968            * @param repositoryId the primary key of the folder's repository
969            * @param parentFolderId the primary key of the folder's parent folder
970            * @param includeMountFolders whether to include mount folders for
971            third-party repositories
972            * @param start the lower bound of the range of results
973            * @param end the upper bound of the range of results (not inclusive)
974            * @return the range of immediate subfolders of the parent folder
975            * @throws PortalException if the parent folder could not be found
976            * @throws SystemException if a system exception occurred
977            */
978            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
979                    long repositoryId, long parentFolderId, boolean includeMountFolders,
980                    int start, int end)
981                    throws com.liferay.portal.kernel.exception.PortalException,
982                            com.liferay.portal.kernel.exception.SystemException {
983                    return _dlAppService.getFolders(repositoryId, parentFolderId,
984                            includeMountFolders, start, end);
985            }
986    
987            /**
988            * Returns an ordered range of all the immediate subfolders of the parent
989            * folder.
990            *
991            * <p>
992            * Useful when paginating results. Returns a maximum of <code>end -
993            * start</code> instances. <code>start</code> and <code>end</code> are not
994            * primary keys, they are indexes in the result set. Thus, <code>0</code>
995            * refers to the first result in the set. Setting both <code>start</code>
996            * and <code>end</code> to {@link
997            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
998            * result set.
999            * </p>
1000            *
1001            * @param repositoryId the primary key of the folder's repository
1002            * @param parentFolderId the primary key of the folder's parent folder
1003            * @param includeMountFolders whether to include mount folders for
1004            third-party repositories
1005            * @param start the lower bound of the range of results
1006            * @param end the upper bound of the range of results (not inclusive)
1007            * @param obc the comparator to order the folders (optionally
1008            <code>null</code>)
1009            * @return the range of immediate subfolders of the parent folder ordered by
1010            comparator <code>obc</code>
1011            * @throws PortalException if the parent folder could not be found
1012            * @throws SystemException if a system exception occurred
1013            */
1014            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
1015                    long repositoryId, long parentFolderId, boolean includeMountFolders,
1016                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1017                    throws com.liferay.portal.kernel.exception.PortalException,
1018                            com.liferay.portal.kernel.exception.SystemException {
1019                    return _dlAppService.getFolders(repositoryId, parentFolderId,
1020                            includeMountFolders, start, end, obc);
1021            }
1022    
1023            /**
1024            * Returns an ordered range of all the immediate subfolders of the parent
1025            * folder.
1026            *
1027            * <p>
1028            * Useful when paginating results. Returns a maximum of <code>end -
1029            * start</code> instances. <code>start</code> and <code>end</code> are not
1030            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1031            * refers to the first result in the set. Setting both <code>start</code>
1032            * and <code>end</code> to {@link
1033            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1034            * result set.
1035            * </p>
1036            *
1037            * @param repositoryId the primary key of the folder's repository
1038            * @param parentFolderId the primary key of the folder's parent folder
1039            * @param status the workflow status
1040            * @param includeMountFolders whether to include mount folders for
1041            third-party repositories
1042            * @param start the lower bound of the range of results
1043            * @param end the upper bound of the range of results (not inclusive)
1044            * @param obc the comparator to order the folders (optionally
1045            <code>null</code>)
1046            * @return the range of immediate subfolders of the parent folder ordered by
1047            comparator <code>obc</code>
1048            * @throws PortalException if the parent folder could not be found
1049            * @throws SystemException if a system exception occurred
1050            */
1051            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
1052                    long repositoryId, long parentFolderId, int status,
1053                    boolean includeMountFolders, int start, int end,
1054                    com.liferay.portal.kernel.util.OrderByComparator obc)
1055                    throws com.liferay.portal.kernel.exception.PortalException,
1056                            com.liferay.portal.kernel.exception.SystemException {
1057                    return _dlAppService.getFolders(repositoryId, parentFolderId, status,
1058                            includeMountFolders, start, end, obc);
1059            }
1060    
1061            /**
1062            * Returns a range of all the immediate subfolders of the parent folder.
1063            *
1064            * <p>
1065            * Useful when paginating results. Returns a maximum of <code>end -
1066            * start</code> instances. <code>start</code> and <code>end</code> are not
1067            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1068            * refers to the first result in the set. Setting both <code>start</code>
1069            * and <code>end</code> to {@link
1070            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1071            * result set.
1072            * </p>
1073            *
1074            * @param repositoryId the primary key of the folder's repository
1075            * @param parentFolderId the primary key of the folder's parent folder
1076            * @param start the lower bound of the range of results
1077            * @param end the upper bound of the range of results (not inclusive)
1078            * @return the range of immediate subfolders of the parent folder
1079            * @throws PortalException if the parent folder could not be found
1080            * @throws SystemException if a system exception occurred
1081            */
1082            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
1083                    long repositoryId, long parentFolderId, int start, int end)
1084                    throws com.liferay.portal.kernel.exception.PortalException,
1085                            com.liferay.portal.kernel.exception.SystemException {
1086                    return _dlAppService.getFolders(repositoryId, parentFolderId, start, end);
1087            }
1088    
1089            /**
1090            * Returns an ordered range of all the immediate subfolders of the parent
1091            * folder.
1092            *
1093            * <p>
1094            * Useful when paginating results. Returns a maximum of <code>end -
1095            * start</code> instances. <code>start</code> and <code>end</code> are not
1096            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1097            * refers to the first result in the set. Setting both <code>start</code>
1098            * and <code>end</code> to {@link
1099            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1100            * result set.
1101            * </p>
1102            *
1103            * @param repositoryId the primary key of the folder's repository
1104            * @param parentFolderId the primary key of the folder's parent folder
1105            * @param start the lower bound of the range of results
1106            * @param end the upper bound of the range of results (not inclusive)
1107            * @param obc the comparator to order the folders (optionally
1108            <code>null</code>)
1109            * @return the range of immediate subfolders of the parent folder ordered by
1110            comparator <code>obc</code>
1111            * @throws PortalException if the parent folder could not be found
1112            * @throws SystemException if a system exception occurred
1113            */
1114            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(
1115                    long repositoryId, long parentFolderId, int start, int end,
1116                    com.liferay.portal.kernel.util.OrderByComparator obc)
1117                    throws com.liferay.portal.kernel.exception.PortalException,
1118                            com.liferay.portal.kernel.exception.SystemException {
1119                    return _dlAppService.getFolders(repositoryId, parentFolderId, start,
1120                            end, obc);
1121            }
1122    
1123            /**
1124            * Returns a range of all the immediate subfolders, file entries, and file
1125            * shortcuts in the parent folder.
1126            *
1127            * <p>
1128            * Useful when paginating results. Returns a maximum of <code>end -
1129            * start</code> instances. <code>start</code> and <code>end</code> are not
1130            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1131            * refers to the first result in the set. Setting both <code>start</code>
1132            * and <code>end</code> to {@link
1133            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1134            * result set.
1135            * </p>
1136            *
1137            * @param repositoryId the primary key of the repository
1138            * @param folderId the primary key of the parent folder
1139            * @param status the workflow status
1140            * @param includeMountFolders whether to include mount folders for
1141            third-party repositories
1142            * @param start the lower bound of the range of results
1143            * @param end the upper bound of the range of results (not inclusive)
1144            * @return the range of immediate subfolders, file entries, and file
1145            shortcuts in the parent folder ordered by comparator
1146            <code>obc</code>
1147            * @throws PortalException if the parent folder could not be found
1148            * @throws SystemException if a system exception occurred
1149            */
1150            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
1151                    long repositoryId, long folderId, int status,
1152                    boolean includeMountFolders, int start, int end)
1153                    throws com.liferay.portal.kernel.exception.PortalException,
1154                            com.liferay.portal.kernel.exception.SystemException {
1155                    return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId,
1156                            folderId, status, includeMountFolders, start, end);
1157            }
1158    
1159            /**
1160            * Returns an ordered range of all the immediate subfolders, file entries,
1161            * and file shortcuts in the parent folder.
1162            *
1163            * <p>
1164            * Useful when paginating results. Returns a maximum of <code>end -
1165            * start</code> instances. <code>start</code> and <code>end</code> are not
1166            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1167            * refers to the first result in the set. Setting both <code>start</code>
1168            * and <code>end</code> to {@link
1169            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1170            * result set.
1171            * </p>
1172            *
1173            * @param repositoryId the primary key of the repository
1174            * @param folderId the primary key of the parent folder
1175            * @param status the workflow status
1176            * @param includeMountFolders whether to include mount folders for
1177            third-party repositories
1178            * @param start the lower bound of the range of results
1179            * @param end the upper bound of the range of results (not inclusive)
1180            * @param obc the comparator to order the results (optionally
1181            <code>null</code>)
1182            * @return the range of immediate subfolders, file entries, and file
1183            shortcuts in the parent folder ordered by comparator
1184            <code>obc</code>
1185            * @throws PortalException if the parent folder could not be found
1186            * @throws SystemException if a system exception occurred
1187            */
1188            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
1189                    long repositoryId, long folderId, int status,
1190                    boolean includeMountFolders, int start, int end,
1191                    com.liferay.portal.kernel.util.OrderByComparator obc)
1192                    throws com.liferay.portal.kernel.exception.PortalException,
1193                            com.liferay.portal.kernel.exception.SystemException {
1194                    return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId,
1195                            folderId, status, includeMountFolders, start, end, obc);
1196            }
1197    
1198            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
1199                    long repositoryId, long folderId, int status,
1200                    java.lang.String[] mimeTypes, boolean includeMountFolders, int start,
1201                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
1202                    throws com.liferay.portal.kernel.exception.PortalException,
1203                            com.liferay.portal.kernel.exception.SystemException {
1204                    return _dlAppService.getFoldersAndFileEntriesAndFileShortcuts(repositoryId,
1205                            folderId, status, mimeTypes, includeMountFolders, start, end, obc);
1206            }
1207    
1208            /**
1209            * Returns the number of immediate subfolders, file entries, and file
1210            * shortcuts in the parent folder.
1211            *
1212            * @param repositoryId the primary key of the repository
1213            * @param folderId the primary key of the parent folder
1214            * @param status the workflow status
1215            * @param includeMountFolders whether to include mount folders for
1216            third-party repositories
1217            * @return the number of immediate subfolders, file entries, and file
1218            shortcuts in the parent folder
1219            * @throws PortalException if the folder could not be found
1220            * @throws SystemException if a system exception occurred
1221            */
1222            public int getFoldersAndFileEntriesAndFileShortcutsCount(
1223                    long repositoryId, long folderId, int status,
1224                    boolean includeMountFolders)
1225                    throws com.liferay.portal.kernel.exception.PortalException,
1226                            com.liferay.portal.kernel.exception.SystemException {
1227                    return _dlAppService.getFoldersAndFileEntriesAndFileShortcutsCount(repositoryId,
1228                            folderId, status, includeMountFolders);
1229            }
1230    
1231            public int getFoldersAndFileEntriesAndFileShortcutsCount(
1232                    long repositoryId, long folderId, int status,
1233                    java.lang.String[] mimeTypes, boolean includeMountFolders)
1234                    throws com.liferay.portal.kernel.exception.PortalException,
1235                            com.liferay.portal.kernel.exception.SystemException {
1236                    return _dlAppService.getFoldersAndFileEntriesAndFileShortcutsCount(repositoryId,
1237                            folderId, status, mimeTypes, includeMountFolders);
1238            }
1239    
1240            /**
1241            * Returns the number of immediate subfolders of the parent folder.
1242            *
1243            * @param repositoryId the primary key of the folder's repository
1244            * @param parentFolderId the primary key of the folder's parent folder
1245            * @return the number of immediate subfolders of the parent folder
1246            * @throws PortalException if the parent folder could not be found
1247            * @throws SystemException if a system exception occurred
1248            */
1249            public int getFoldersCount(long repositoryId, long parentFolderId)
1250                    throws com.liferay.portal.kernel.exception.PortalException,
1251                            com.liferay.portal.kernel.exception.SystemException {
1252                    return _dlAppService.getFoldersCount(repositoryId, parentFolderId);
1253            }
1254    
1255            /**
1256            * Returns the number of immediate subfolders of the parent folder,
1257            * optionally including mount folders for third-party repositories.
1258            *
1259            * @param repositoryId the primary key of the folder's repository
1260            * @param parentFolderId the primary key of the folder's parent folder
1261            * @param includeMountFolders whether to include mount folders for
1262            third-party repositories
1263            * @return the number of immediate subfolders of the parent folder
1264            * @throws PortalException if the parent folder could not be found
1265            * @throws SystemException if a system exception occurred
1266            */
1267            public int getFoldersCount(long repositoryId, long parentFolderId,
1268                    boolean includeMountFolders)
1269                    throws com.liferay.portal.kernel.exception.PortalException,
1270                            com.liferay.portal.kernel.exception.SystemException {
1271                    return _dlAppService.getFoldersCount(repositoryId, parentFolderId,
1272                            includeMountFolders);
1273            }
1274    
1275            /**
1276            * Returns the number of immediate subfolders of the parent folder,
1277            * optionally including mount folders for third-party repositories.
1278            *
1279            * @param repositoryId the primary key of the folder's repository
1280            * @param parentFolderId the primary key of the folder's parent folder
1281            * @param status the workflow status
1282            * @param includeMountFolders whether to include mount folders for
1283            third-party repositories
1284            * @return the number of immediate subfolders of the parent folder
1285            * @throws PortalException if the parent folder could not be found
1286            * @throws SystemException if a system exception occurred
1287            */
1288            public int getFoldersCount(long repositoryId, long parentFolderId,
1289                    int status, boolean includeMountFolders)
1290                    throws com.liferay.portal.kernel.exception.PortalException,
1291                            com.liferay.portal.kernel.exception.SystemException {
1292                    return _dlAppService.getFoldersCount(repositoryId, parentFolderId,
1293                            status, includeMountFolders);
1294            }
1295    
1296            /**
1297            * Returns the number of immediate subfolders and file entries across the
1298            * folders.
1299            *
1300            * @param repositoryId the primary key of the repository
1301            * @param folderIds the primary keys of folders from which to count
1302            immediate subfolders and file entries
1303            * @param status the workflow status
1304            * @return the number of immediate subfolders and file entries across the
1305            folders
1306            * @throws PortalException if the repository could not be found
1307            * @throws SystemException if a system exception occurred
1308            */
1309            public int getFoldersFileEntriesCount(long repositoryId,
1310                    java.util.List<java.lang.Long> folderIds, int status)
1311                    throws com.liferay.portal.kernel.exception.PortalException,
1312                            com.liferay.portal.kernel.exception.SystemException {
1313                    return _dlAppService.getFoldersFileEntriesCount(repositoryId,
1314                            folderIds, status);
1315            }
1316    
1317            /**
1318            * Returns an ordered range of all the file entries in the group starting at
1319            * the repository default parent folder that are stored within the Liferay
1320            * repository. This method is primarily used to search for recently modified
1321            * file entries. It can be limited to the file entries modified by a given
1322            * user.
1323            *
1324            * <p>
1325            * Useful when paginating results. Returns a maximum of <code>end -
1326            * start</code> instances. <code>start</code> and <code>end</code> are not
1327            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1328            * refers to the first result in the set. Setting both <code>start</code>
1329            * and <code>end</code> to {@link
1330            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1331            * result set.
1332            * </p>
1333            *
1334            * @param groupId the primary key of the group
1335            * @param userId the primary key of the user who created the file
1336            (optionally <code>0</code>)
1337            * @param start the lower bound of the range of results
1338            * @param end the upper bound of the range of results (not inclusive)
1339            * @return the range of matching file entries ordered by date modified
1340            * @throws PortalException if the group could not be found
1341            * @throws SystemException if a system exception occurred
1342            */
1343            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries(
1344                    long groupId, long userId, int start, int end)
1345                    throws com.liferay.portal.kernel.exception.PortalException,
1346                            com.liferay.portal.kernel.exception.SystemException {
1347                    return _dlAppService.getGroupFileEntries(groupId, userId, start, end);
1348            }
1349    
1350            /**
1351            * Returns an ordered range of all the file entries in the group that are
1352            * stored within the Liferay repository. This method is primarily used to
1353            * search for recently modified file entries. It can be limited to the file
1354            * entries modified by a given user.
1355            *
1356            * <p>
1357            * Useful when paginating results. Returns a maximum of <code>end -
1358            * start</code> instances. <code>start</code> and <code>end</code> are not
1359            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1360            * refers to the first result in the set. Setting both <code>start</code>
1361            * and <code>end</code> to {@link
1362            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1363            * result set.
1364            * </p>
1365            *
1366            * @param groupId the primary key of the group
1367            * @param userId the primary key of the user who created the file
1368            (optionally <code>0</code>)
1369            * @param start the lower bound of the range of results
1370            * @param end the upper bound of the range of results (not inclusive)
1371            * @param obc the comparator to order the file entries (optionally
1372            <code>null</code>)
1373            * @return the range of matching file entries ordered by comparator
1374            <code>obc</code>
1375            * @throws PortalException if the group could not be found
1376            * @throws SystemException if a system exception occurred
1377            */
1378            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries(
1379                    long groupId, long userId, int start, int end,
1380                    com.liferay.portal.kernel.util.OrderByComparator obc)
1381                    throws com.liferay.portal.kernel.exception.PortalException,
1382                            com.liferay.portal.kernel.exception.SystemException {
1383                    return _dlAppService.getGroupFileEntries(groupId, userId, start, end,
1384                            obc);
1385            }
1386    
1387            /**
1388            * Returns an ordered range of all the file entries in the group starting at
1389            * the root folder that are stored within the Liferay repository. This
1390            * method is primarily used to search for recently modified file entries. It
1391            * can be limited to the file entries modified by a given user.
1392            *
1393            * <p>
1394            * Useful when paginating results. Returns a maximum of <code>end -
1395            * start</code> instances. <code>start</code> and <code>end</code> are not
1396            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1397            * refers to the first result in the set. Setting both <code>start</code>
1398            * and <code>end</code> to {@link
1399            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1400            * result set.
1401            * </p>
1402            *
1403            * @param groupId the primary key of the group
1404            * @param userId the primary key of the user who created the file
1405            (optionally <code>0</code>)
1406            * @param rootFolderId the primary key of the root folder to begin the
1407            search
1408            * @param start the lower bound of the range of results
1409            * @param end the upper bound of the range of results (not inclusive)
1410            * @return the range of matching file entries ordered by date modified
1411            * @throws PortalException if the group could not be found
1412            * @throws SystemException if a system exception occurred
1413            */
1414            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries(
1415                    long groupId, long userId, long rootFolderId, int start, int end)
1416                    throws com.liferay.portal.kernel.exception.PortalException,
1417                            com.liferay.portal.kernel.exception.SystemException {
1418                    return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId,
1419                            start, end);
1420            }
1421    
1422            /**
1423            * Returns an ordered range of all the file entries in the group starting at
1424            * the root folder that are stored within the Liferay repository. This
1425            * method is primarily used to search for recently modified file entries. It
1426            * can be limited to the file entries modified by a given user.
1427            *
1428            * <p>
1429            * Useful when paginating results. Returns a maximum of <code>end -
1430            * start</code> instances. <code>start</code> and <code>end</code> are not
1431            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1432            * refers to the first result in the set. Setting both <code>start</code>
1433            * and <code>end</code> to {@link
1434            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1435            * result set.
1436            * </p>
1437            *
1438            * @param groupId the primary key of the group
1439            * @param userId the primary key of the user who created the file
1440            (optionally <code>0</code>)
1441            * @param rootFolderId the primary key of the root folder to begin the
1442            search
1443            * @param start the lower bound of the range of results
1444            * @param end the upper bound of the range of results (not inclusive)
1445            * @param obc the comparator to order the file entries (optionally
1446            <code>null</code>)
1447            * @return the range of matching file entries ordered by comparator
1448            <code>obc</code>
1449            * @throws PortalException if the group could not be found
1450            * @throws SystemException if a system exception occurred
1451            */
1452            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries(
1453                    long groupId, long userId, long rootFolderId, int start, int end,
1454                    com.liferay.portal.kernel.util.OrderByComparator obc)
1455                    throws com.liferay.portal.kernel.exception.PortalException,
1456                            com.liferay.portal.kernel.exception.SystemException {
1457                    return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId,
1458                            start, end, obc);
1459            }
1460    
1461            public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getGroupFileEntries(
1462                    long groupId, long userId, long rootFolderId,
1463                    java.lang.String[] mimeTypes, int status, int start, int end,
1464                    com.liferay.portal.kernel.util.OrderByComparator obc)
1465                    throws com.liferay.portal.kernel.exception.PortalException,
1466                            com.liferay.portal.kernel.exception.SystemException {
1467                    return _dlAppService.getGroupFileEntries(groupId, userId, rootFolderId,
1468                            mimeTypes, status, start, end, obc);
1469            }
1470    
1471            /**
1472            * Returns the number of file entries in a group starting at the repository
1473            * default parent folder that are stored within the Liferay repository. This
1474            * method is primarily used to search for recently modified file entries. It
1475            * can be limited to the file entries modified by a given user.
1476            *
1477            * @param groupId the primary key of the group
1478            * @param userId the primary key of the user who created the file
1479            (optionally <code>0</code>)
1480            * @return the number of matching file entries
1481            * @throws PortalException if the group could not be found
1482            * @throws SystemException if a system exception occurred
1483            */
1484            public int getGroupFileEntriesCount(long groupId, long userId)
1485                    throws com.liferay.portal.kernel.exception.PortalException,
1486                            com.liferay.portal.kernel.exception.SystemException {
1487                    return _dlAppService.getGroupFileEntriesCount(groupId, userId);
1488            }
1489    
1490            /**
1491            * Returns the number of file entries in a group starting at the root folder
1492            * that are stored within the Liferay repository. This method is primarily
1493            * used to search for recently modified file entries. It can be limited to
1494            * the file entries modified by a given user.
1495            *
1496            * @param groupId the primary key of the group
1497            * @param userId the primary key of the user who created the file
1498            (optionally <code>0</code>)
1499            * @param rootFolderId the primary key of the root folder to begin the
1500            search
1501            * @return the number of matching file entries
1502            * @throws PortalException if the group could not be found
1503            * @throws SystemException if a system exception occurred
1504            */
1505            public int getGroupFileEntriesCount(long groupId, long userId,
1506                    long rootFolderId)
1507                    throws com.liferay.portal.kernel.exception.PortalException,
1508                            com.liferay.portal.kernel.exception.SystemException {
1509                    return _dlAppService.getGroupFileEntriesCount(groupId, userId,
1510                            rootFolderId);
1511            }
1512    
1513            public int getGroupFileEntriesCount(long groupId, long userId,
1514                    long rootFolderId, java.lang.String[] mimeTypes, int status)
1515                    throws com.liferay.portal.kernel.exception.PortalException,
1516                            com.liferay.portal.kernel.exception.SystemException {
1517                    return _dlAppService.getGroupFileEntriesCount(groupId, userId,
1518                            rootFolderId, mimeTypes, status);
1519            }
1520    
1521            /**
1522            * Returns all immediate subfolders of the parent folder that are used for
1523            * mounting third-party repositories. This method is only supported by the
1524            * Liferay repository.
1525            *
1526            * @param repositoryId the primary key of the folder's repository
1527            * @param parentFolderId the primary key of the folder's parent folder
1528            * @return the immediate subfolders of the parent folder that are used for
1529            mounting third-party repositories
1530            * @throws PortalException if the repository or parent folder could not be
1531            found
1532            * @throws SystemException if a system exception occurred
1533            */
1534            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders(
1535                    long repositoryId, long parentFolderId)
1536                    throws com.liferay.portal.kernel.exception.PortalException,
1537                            com.liferay.portal.kernel.exception.SystemException {
1538                    return _dlAppService.getMountFolders(repositoryId, parentFolderId);
1539            }
1540    
1541            /**
1542            * Returns a range of all the immediate subfolders of the parent folder that
1543            * are used for mounting third-party repositories. This method is only
1544            * supported by the Liferay repository.
1545            *
1546            * <p>
1547            * Useful when paginating results. Returns a maximum of <code>end -
1548            * start</code> instances. <code>start</code> and <code>end</code> are not
1549            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1550            * refers to the first result in the set. Setting both <code>start</code>
1551            * and <code>end</code> to {@link
1552            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1553            * result set.
1554            * </p>
1555            *
1556            * @param repositoryId the primary key of the repository
1557            * @param parentFolderId the primary key of the parent folder
1558            * @param start the lower bound of the range of results
1559            * @param end the upper bound of the range of results (not inclusive)
1560            * @return the range of immediate subfolders of the parent folder that are
1561            used for mounting third-party repositories
1562            * @throws PortalException if the repository or parent folder could not be
1563            found
1564            * @throws SystemException if a system exception occurred
1565            */
1566            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders(
1567                    long repositoryId, long parentFolderId, int start, int end)
1568                    throws com.liferay.portal.kernel.exception.PortalException,
1569                            com.liferay.portal.kernel.exception.SystemException {
1570                    return _dlAppService.getMountFolders(repositoryId, parentFolderId,
1571                            start, end);
1572            }
1573    
1574            /**
1575            * Returns an ordered range of all the immediate subfolders of the parent
1576            * folder that are used for mounting third-party repositories. This method
1577            * is only supported by the Liferay repository.
1578            *
1579            * <p>
1580            * Useful when paginating results. Returns a maximum of <code>end -
1581            * start</code> instances. <code>start</code> and <code>end</code> are not
1582            * primary keys, they are indexes in the result set. Thus, <code>0</code>
1583            * refers to the first result in the set. Setting both <code>start</code>
1584            * and <code>end</code> to {@link
1585            * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
1586            * result set.
1587            * </p>
1588            *
1589            * @param repositoryId the primary key of the folder's repository
1590            * @param parentFolderId the primary key of the folder's parent folder
1591            * @param start the lower bound of the range of results
1592            * @param end the upper bound of the range of results (not inclusive)
1593            * @param obc the comparator to order the folders (optionally
1594            <code>null</code>)
1595            * @return the range of immediate subfolders of the parent folder that are
1596            used for mounting third-party repositories ordered by comparator
1597            <code>obc</code>
1598            * @throws PortalException if the repository or parent folder could not be
1599            found
1600            * @throws SystemException if a system exception occurred
1601            */
1602            public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders(
1603                    long repositoryId, long parentFolderId, int start, int end,
1604                    com.liferay.portal.kernel.util.OrderByComparator obc)
1605                    throws com.liferay.portal.kernel.exception.PortalException,
1606                            com.liferay.portal.kernel.exception.SystemException {
1607                    return _dlAppService.getMountFolders(repositoryId, parentFolderId,
1608                            start, end, obc);
1609            }
1610    
1611            /**
1612            * Returns the number of immediate subfolders of the parent folder that are
1613            * used for mounting third-party repositories. This method is only supported
1614            * by the Liferay repository.
1615            *
1616            * @param repositoryId the primary key of the repository
1617            * @param parentFolderId the primary key of the parent folder
1618            * @return the number of folders of the parent folder that are used for
1619            mounting third-party repositories
1620            * @throws PortalException if the repository or parent folder could not be
1621            found
1622            * @throws SystemException if a system exception occurred
1623            */
1624            public int getMountFoldersCount(long repositoryId, long parentFolderId)
1625                    throws com.liferay.portal.kernel.exception.PortalException,
1626                            com.liferay.portal.kernel.exception.SystemException {
1627                    return _dlAppService.getMountFoldersCount(repositoryId, parentFolderId);
1628            }
1629    
1630            public void getSubfolderIds(long repositoryId,
1631                    java.util.List<java.lang.Long> folderIds, long folderId)
1632                    throws com.liferay.portal.kernel.exception.PortalException,
1633                            com.liferay.portal.kernel.exception.SystemException {
1634                    _dlAppService.getSubfolderIds(repositoryId, folderIds, folderId);
1635            }
1636    
1637            /**
1638            * Returns all the descendant folders of the folder with the primary key.
1639            *
1640            * @param repositoryId the primary key of the repository
1641            * @param folderId the primary key of the folder
1642            * @return the descendant folders of the folder with the primary key
1643            * @throws PortalException if the repository or parent folder could not be
1644            found
1645            * @throws SystemException if a system exception occurred
1646            */
1647            public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId,
1648                    long folderId)
1649                    throws com.liferay.portal.kernel.exception.PortalException,
1650                            com.liferay.portal.kernel.exception.SystemException {
1651                    return _dlAppService.getSubfolderIds(repositoryId, folderId);
1652            }
1653    
1654            /**
1655            * Returns descendant folders of the folder with the primary key, optionally
1656            * limiting to one level deep.
1657            *
1658            * @param repositoryId the primary key of the repository
1659            * @param folderId the primary key of the folder
1660            * @param recurse whether to recurse through each subfolder
1661            * @return the descendant folders of the folder with the primary key
1662            * @throws PortalException if the repository or parent folder could not be
1663            found
1664            * @throws SystemException if a system exception occurred
1665            */
1666            public java.util.List<java.lang.Long> getSubfolderIds(long repositoryId,
1667                    long folderId, boolean recurse)
1668                    throws com.liferay.portal.kernel.exception.PortalException,
1669                            com.liferay.portal.kernel.exception.SystemException {
1670                    return _dlAppService.getSubfolderIds(repositoryId, folderId, recurse);
1671            }
1672    
1673            /**
1674            * Returns all the temporary file entry names.
1675            *
1676            * @param groupId the primary key of the group
1677            * @param folderId the primary key of the folder where the file entry will
1678            eventually reside
1679            * @param tempFolderName the temporary folder's name
1680            * @return the temporary file entry names
1681            * @throws PortalException if the folder was invalid
1682            * @throws SystemException if a system exception occurred
1683            * @see com.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl#addTempFileEntry(
1684            long, long, String, String, File)
1685            * @see com.liferay.portal.kernel.util.TempFileUtil
1686            */
1687            public java.lang.String[] getTempFileEntryNames(long groupId,
1688                    long folderId, java.lang.String tempFolderName)
1689                    throws com.liferay.portal.kernel.exception.PortalException,
1690                            com.liferay.portal.kernel.exception.SystemException {
1691                    return _dlAppService.getTempFileEntryNames(groupId, folderId,
1692                            tempFolderName);
1693            }
1694    
1695            /**
1696            * @deprecated {@link #checkOutFileEntry(long, ServiceContext)}
1697            */
1698            public com.liferay.portal.model.Lock lockFileEntry(long fileEntryId)
1699                    throws com.liferay.portal.kernel.exception.PortalException,
1700                            com.liferay.portal.kernel.exception.SystemException {
1701                    return _dlAppService.lockFileEntry(fileEntryId);
1702            }
1703    
1704            /**
1705            * @deprecated {@link #checkOutFileEntry(long, String, long,
1706            ServiceContext)}
1707            */
1708            public com.liferay.portal.model.Lock lockFileEntry(long fileEntryId,
1709                    java.lang.String owner, long expirationTime)
1710                    throws com.liferay.portal.kernel.exception.PortalException,
1711                            com.liferay.portal.kernel.exception.SystemException {
1712                    return _dlAppService.lockFileEntry(fileEntryId, owner, expirationTime);
1713            }
1714    
1715            /**
1716            * Locks the folder. This method is primarily used by WebDAV.
1717            *
1718            * @param repositoryId the primary key of the repository
1719            * @param folderId the primary key of the folder
1720            * @return the lock object
1721            * @throws PortalException if the repository or folder could not be found
1722            * @throws SystemException if a system exception occurred
1723            */
1724            public com.liferay.portal.model.Lock lockFolder(long repositoryId,
1725                    long folderId)
1726                    throws com.liferay.portal.kernel.exception.PortalException,
1727                            com.liferay.portal.kernel.exception.SystemException {
1728                    return _dlAppService.lockFolder(repositoryId, folderId);
1729            }
1730    
1731            /**
1732            * Locks the folder. This method is primarily used by WebDAV.
1733            *
1734            * @param repositoryId the primary key of the repository
1735            * @param folderId the primary key of the folder
1736            * @param owner the owner string for the checkout (optionally
1737            <code>null</code>)
1738            * @param inheritable whether the lock must propagate to descendants
1739            * @param expirationTime the time in milliseconds before the lock expires.
1740            If the value is <code>0</code>, the default expiration time will
1741            be used from <code>portal.properties>.
1742            * @return the lock object
1743            * @throws PortalException if the repository or folder could not be found
1744            * @throws SystemException if a system exception occurred
1745            */
1746            public com.liferay.portal.model.Lock lockFolder(long repositoryId,
1747                    long folderId, java.lang.String owner, boolean inheritable,
1748                    long expirationTime)
1749                    throws com.liferay.portal.kernel.exception.PortalException,
1750                            com.liferay.portal.kernel.exception.SystemException {
1751                    return _dlAppService.lockFolder(repositoryId, folderId, owner,
1752                            inheritable, expirationTime);
1753            }
1754    
1755            /**
1756            * Moves the file entry to the new folder.
1757            *
1758            * @param fileEntryId the primary key of the file entry
1759            * @param newFolderId the primary key of the new folder
1760            * @param serviceContext the service context to be applied
1761            * @return the file entry
1762            * @throws PortalException if the file entry or the new folder could not be
1763            found
1764            * @throws SystemException if a system exception occurred
1765            */
1766            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry(
1767                    long fileEntryId, long newFolderId,
1768                    com.liferay.portal.service.ServiceContext serviceContext)
1769                    throws com.liferay.portal.kernel.exception.PortalException,
1770                            com.liferay.portal.kernel.exception.SystemException {
1771                    return _dlAppService.moveFileEntry(fileEntryId, newFolderId,
1772                            serviceContext);
1773            }
1774    
1775            /**
1776            * Moves the file entry from a trashed folder to the new folder.
1777            *
1778            * @param fileEntryId the primary key of the file entry
1779            * @param newFolderId the primary key of the new folder
1780            * @param serviceContext the service context to be applied
1781            * @return the file entry
1782            * @throws PortalException if the file entry or the new folder could not be
1783            found
1784            * @throws SystemException if a system exception occurred
1785            */
1786            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryFromTrash(
1787                    long fileEntryId, long newFolderId,
1788                    com.liferay.portal.service.ServiceContext serviceContext)
1789                    throws com.liferay.portal.kernel.exception.PortalException,
1790                            com.liferay.portal.kernel.exception.SystemException {
1791                    return _dlAppService.moveFileEntryFromTrash(fileEntryId, newFolderId,
1792                            serviceContext);
1793            }
1794    
1795            /**
1796            * Moves the file entry with the primary key to the trash portlet.
1797            *
1798            * @param fileEntryId the primary key of the file entry
1799            * @throws PortalException if the file entry could not be found
1800            * @throws SystemException if a system exception occurred
1801            */
1802            public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash(
1803                    long fileEntryId)
1804                    throws com.liferay.portal.kernel.exception.PortalException,
1805                            com.liferay.portal.kernel.exception.SystemException {
1806                    return _dlAppService.moveFileEntryToTrash(fileEntryId);
1807            }
1808    
1809            /**
1810            * Moves the file shortcut from a trashed folder to the new folder.
1811            *
1812            * @param fileShortcutId the primary key of the file shortcut
1813            * @param newFolderId the primary key of the new folder
1814            * @param serviceContext the service context to be applied
1815            * @return the file shortcut
1816            * @throws PortalException if the file entry or the new folder could not be
1817            found
1818            * @throws SystemException if a system exception occurred
1819            */
1820            public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutFromTrash(
1821                    long fileShortcutId, long newFolderId,
1822                    com.liferay.portal.service.ServiceContext serviceContext)
1823                    throws com.liferay.portal.kernel.exception.PortalException,
1824                            com.liferay.portal.kernel.exception.SystemException {
1825                    return _dlAppService.moveFileShortcutFromTrash(fileShortcutId,
1826                            newFolderId, serviceContext);
1827            }
1828    
1829            /**
1830            * Moves the file shortcut with the primary key to the trash portlet.
1831            *
1832            * @param fileShortcutId the primary key of the file shortcut
1833            * @return the file shortcut
1834            * @throws PortalException if the file shortcut could not be found
1835            * @throws SystemException if a system exception occurred
1836            */
1837            public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutToTrash(
1838                    long fileShortcutId)
1839                    throws com.liferay.portal.kernel.exception.PortalException,
1840                            com.liferay.portal.kernel.exception.SystemException {
1841                    return _dlAppService.moveFileShortcutToTrash(fileShortcutId);
1842            }
1843    
1844            /**
1845            * Moves the folder to the new parent folder with the primary key.
1846            *
1847            * @param folderId the primary key of the folder
1848            * @param parentFolderId the primary key of the new parent folder
1849            * @param serviceContext the service context to be applied
1850            * @return the file entry
1851            * @throws PortalException if the folder could not be found
1852            * @throws SystemException if a system exception occurred
1853            */
1854            public com.liferay.portal.kernel.repository.model.Folder moveFolder(
1855                    long folderId, long parentFolderId,
1856                    com.liferay.portal.service.ServiceContext serviceContext)
1857                    throws com.liferay.portal.kernel.exception.PortalException,
1858                            com.liferay.portal.kernel.exception.SystemException {
1859                    return _dlAppService.moveFolder(folderId, parentFolderId, serviceContext);
1860            }
1861    
1862            /**
1863            * Moves the folder with the primary key from the trash portlet to the new
1864            * parent folder with the primary key.
1865            *
1866            * @param folderId the primary key of the folder
1867            * @param parentFolderId the primary key of the new parent folder
1868            * @param serviceContext the service context to be applied
1869            * @return the file entry
1870            * @throws PortalException if the folder could not be found
1871            * @throws SystemException if a system exception occurred
1872            */
1873            public com.liferay.portal.kernel.repository.model.Folder moveFolderFromTrash(
1874                    long folderId, long parentFolderId,
1875                    com.liferay.portal.service.ServiceContext serviceContext)
1876                    throws com.liferay.portal.kernel.exception.PortalException,
1877                            com.liferay.portal.kernel.exception.SystemException {
1878                    return _dlAppService.moveFolderFromTrash(folderId, parentFolderId,
1879                            serviceContext);
1880            }
1881    
1882            /**
1883            * Moves the folder with the primary key to the trash portlet.
1884            *
1885            * @param folderId the primary key of the folder
1886            * @throws PortalException if the folder could not be found
1887            * @throws SystemException if a system exception occurred
1888            */
1889            public com.liferay.portal.kernel.repository.model.Folder moveFolderToTrash(
1890                    long folderId)
1891                    throws com.liferay.portal.kernel.exception.PortalException,
1892                            com.liferay.portal.kernel.exception.SystemException {
1893                    return _dlAppService.moveFolderToTrash(folderId);
1894            }
1895    
1896            /**
1897            * Refreshes the lock for the file entry. This method is primarily used by
1898            * WebDAV.
1899            *
1900            * @param lockUuid the lock's UUID
1901            * @param companyId the primary key of the file entry's company
1902            * @param expirationTime the time in milliseconds before the lock expires.
1903            If the value is <code>0</code>, the default expiration time will
1904            be used from <code>portal.properties>.
1905            * @return the lock object
1906            * @throws PortalException if the file entry or lock could not be found
1907            * @throws SystemException if a system exception occurred
1908            */
1909            public com.liferay.portal.model.Lock refreshFileEntryLock(
1910                    java.lang.String lockUuid, long companyId, long expirationTime)
1911                    throws com.liferay.portal.kernel.exception.PortalException,
1912                            com.liferay.portal.kernel.exception.SystemException {
1913                    return _dlAppService.refreshFileEntryLock(lockUuid, companyId,
1914                            expirationTime);
1915            }
1916    
1917            /**
1918            * Refreshes the lock for the folder. This method is primarily used by
1919            * WebDAV.
1920            *
1921            * @param lockUuid the lock's UUID
1922            * @param companyId the primary key of the file entry's company
1923            * @param expirationTime the time in milliseconds before the lock expires.
1924            If the value is <code>0</code>, the default expiration time will
1925            be used from <code>portal.properties>.
1926            * @return the lock object
1927            * @throws PortalException if the folder or lock could not be found
1928            * @throws SystemException if a system exception occurred
1929            */
1930            public com.liferay.portal.model.Lock refreshFolderLock(
1931                    java.lang.String lockUuid, long companyId, long expirationTime)
1932                    throws com.liferay.portal.kernel.exception.PortalException,
1933                            com.liferay.portal.kernel.exception.SystemException {
1934                    return _dlAppService.refreshFolderLock(lockUuid, companyId,
1935                            expirationTime);
1936            }
1937    
1938            /**
1939            * Restores the file entry with the primary key from the trash portlet.
1940            *
1941            * @param fileEntryId the primary key of the file entry
1942            * @throws PortalException if the file entry could not be found
1943            * @throws SystemException if a system exception occurred
1944            */
1945            public void restoreFileEntryFromTrash(long fileEntryId)
1946                    throws com.liferay.portal.kernel.exception.PortalException,
1947                            com.liferay.portal.kernel.exception.SystemException {
1948                    _dlAppService.restoreFileEntryFromTrash(fileEntryId);
1949            }
1950    
1951            /**
1952            * Restores the file shortcut with the primary key from the trash portlet.
1953            *
1954            * @param fileShortcutId the primary key of the file shortcut
1955            * @throws PortalException if the file shortcut could not be found
1956            * @throws SystemException if a system exception occurred
1957            */
1958            public void restoreFileShortcutFromTrash(long fileShortcutId)
1959                    throws com.liferay.portal.kernel.exception.PortalException,
1960                            com.liferay.portal.kernel.exception.SystemException {
1961                    _dlAppService.restoreFileShortcutFromTrash(fileShortcutId);
1962            }
1963    
1964            /**
1965            * Restores the folder with the primary key from the trash portlet.
1966            *
1967            * @param folderId the primary key of the folder
1968            * @throws PortalException if the folder could not be found
1969            * @throws SystemException if a system exception occurred
1970            */
1971            public void restoreFolderFromTrash(long folderId)
1972                    throws com.liferay.portal.kernel.exception.PortalException,
1973                            com.liferay.portal.kernel.exception.SystemException {
1974                    _dlAppService.restoreFolderFromTrash(folderId);
1975            }
1976    
1977            /**
1978            * Reverts the file entry to a previous version. A new version will be
1979            * created based on the previous version and metadata.
1980            *
1981            * @param fileEntryId the primary key of the file entry
1982            * @param version the version to revert back to
1983            * @param serviceContext the service context to be applied
1984            * @throws PortalException if the file entry or version could not be found
1985            * @throws SystemException if a system exception occurred
1986            */
1987            public void revertFileEntry(long fileEntryId, java.lang.String version,
1988                    com.liferay.portal.service.ServiceContext serviceContext)
1989                    throws com.liferay.portal.kernel.exception.PortalException,
1990                            com.liferay.portal.kernel.exception.SystemException {
1991                    _dlAppService.revertFileEntry(fileEntryId, version, serviceContext);
1992            }
1993    
1994            public com.liferay.portal.kernel.search.Hits search(long repositoryId,
1995                    com.liferay.portal.kernel.search.SearchContext searchContext)
1996                    throws com.liferay.portal.kernel.search.SearchException {
1997                    return _dlAppService.search(repositoryId, searchContext);
1998            }
1999    
2000            public com.liferay.portal.kernel.search.Hits search(long repositoryId,
2001                    com.liferay.portal.kernel.search.SearchContext searchContext,
2002                    com.liferay.portal.kernel.search.Query query)
2003                    throws com.liferay.portal.kernel.search.SearchException {
2004                    return _dlAppService.search(repositoryId, searchContext, query);
2005            }
2006    
2007            /**
2008            * Subscribe the user to changes in documents of the file entry type. This
2009            * method is only supported by the Liferay repository.
2010            *
2011            * @param groupId the primary key of the file entry type's group
2012            * @param fileEntryTypeId the primary key of the file entry type
2013            * @throws PortalException if the user or group could not be found, or if
2014            subscribing was not permissible
2015            * @throws SystemException if a system exception occurred
2016            */
2017            public void subscribeFileEntryType(long groupId, long fileEntryTypeId)
2018                    throws com.liferay.portal.kernel.exception.PortalException,
2019                            com.liferay.portal.kernel.exception.SystemException {
2020                    _dlAppService.subscribeFileEntryType(groupId, fileEntryTypeId);
2021            }
2022    
2023            /**
2024            * Subscribe the user to document changes in the folder. This method is only
2025            * supported by the Liferay repository.
2026            *
2027            * @param groupId the primary key of the folder's group
2028            * @param folderId the primary key of the folder
2029            * @throws PortalException if the user or group could not be found, or if
2030            subscribing was not permissible
2031            * @throws SystemException if a system exception occurred
2032            */
2033            public void subscribeFolder(long groupId, long folderId)
2034                    throws com.liferay.portal.kernel.exception.PortalException,
2035                            com.liferay.portal.kernel.exception.SystemException {
2036                    _dlAppService.subscribeFolder(groupId, folderId);
2037            }
2038    
2039            /**
2040            * @deprecated Use {@link #checkInFileEntry(long, boolean, String,
2041            ServiceContext)}.
2042            */
2043            public void unlockFileEntry(long fileEntryId)
2044                    throws com.liferay.portal.kernel.exception.PortalException,
2045                            com.liferay.portal.kernel.exception.SystemException {
2046                    _dlAppService.unlockFileEntry(fileEntryId);
2047            }
2048    
2049            /**
2050            * @deprecated Use {@link #checkInFileEntry(long, String)}.
2051            */
2052            public void unlockFileEntry(long fileEntryId, java.lang.String lockUuid)
2053                    throws com.liferay.portal.kernel.exception.PortalException,
2054                            com.liferay.portal.kernel.exception.SystemException {
2055                    _dlAppService.unlockFileEntry(fileEntryId, lockUuid);
2056            }
2057    
2058            /**
2059            * Unlocks the folder. This method is primarily used by WebDAV.
2060            *
2061            * @param repositoryId the primary key of the repository
2062            * @param folderId the primary key of the folder
2063            * @param lockUuid the lock's UUID
2064            * @throws PortalException if the repository or folder could not be found
2065            * @throws SystemException if a system exception occurred
2066            */
2067            public void unlockFolder(long repositoryId, long folderId,
2068                    java.lang.String lockUuid)
2069                    throws com.liferay.portal.kernel.exception.PortalException,
2070                            com.liferay.portal.kernel.exception.SystemException {
2071                    _dlAppService.unlockFolder(repositoryId, folderId, lockUuid);
2072            }
2073    
2074            /**
2075            * Unlocks the folder. This method is primarily used by WebDAV.
2076            *
2077            * @param repositoryId the primary key of the repository
2078            * @param parentFolderId the primary key of the parent folder
2079            * @param name the folder's name
2080            * @param lockUuid the lock's UUID
2081            * @throws PortalException if the repository or folder could not be found
2082            * @throws SystemException if a system exception occurred
2083            */
2084            public void unlockFolder(long repositoryId, long parentFolderId,
2085                    java.lang.String name, java.lang.String lockUuid)
2086                    throws com.liferay.portal.kernel.exception.PortalException,
2087                            com.liferay.portal.kernel.exception.SystemException {
2088                    _dlAppService.unlockFolder(repositoryId, parentFolderId, name, lockUuid);
2089            }
2090    
2091            /**
2092            * Unsubscribe the user from changes in documents of the file entry type.
2093            * This method is only supported by the Liferay repository.
2094            *
2095            * @param groupId the primary key of the file entry type's group
2096            * @param fileEntryTypeId the primary key of the file entry type
2097            * @throws PortalException if the user or group could not be found, or if
2098            unsubscribing was not permissible
2099            * @throws SystemException if a system exception occurred
2100            */
2101            public void unsubscribeFileEntryType(long groupId, long fileEntryTypeId)
2102                    throws com.liferay.portal.kernel.exception.PortalException,
2103                            com.liferay.portal.kernel.exception.SystemException {
2104                    _dlAppService.unsubscribeFileEntryType(groupId, fileEntryTypeId);
2105            }
2106    
2107            /**
2108            * Unsubscribe the user from document changes in the folder. This method is
2109            * only supported by the Liferay repository.
2110            *
2111            * @param groupId the primary key of the folder's group
2112            * @param folderId the primary key of the folder
2113            * @throws PortalException if the user or group could not be found, or if
2114            unsubscribing was not permissible
2115            * @throws SystemException if a system exception occurred
2116            */
2117            public void unsubscribeFolder(long groupId, long folderId)
2118                    throws com.liferay.portal.kernel.exception.PortalException,
2119                            com.liferay.portal.kernel.exception.SystemException {
2120                    _dlAppService.unsubscribeFolder(groupId, folderId);
2121            }
2122    
2123            /**
2124            * Updates a file entry and associated metadata based on a byte array
2125            * object. If the file data is <code>null</code>, then only the associated
2126            * metadata (i.e., <code>title</code>, <code>description</code>, and
2127            * parameters in the <code>serviceContext</code>) will be updated.
2128            *
2129            * <p>
2130            * This method takes two file names, the <code>sourceFileName</code> and the
2131            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
2132            * name of the actual file being uploaded. The <code>title</code>
2133            * corresponds to a name the client wishes to assign this file after it has
2134            * been uploaded to the portal.
2135            * </p>
2136            *
2137            * @param fileEntryId the primary key of the file entry
2138            * @param sourceFileName the original file's name (optionally
2139            <code>null</code>)
2140            * @param mimeType the file's MIME type (optionally <code>null</code>)
2141            * @param title the new name to be assigned to the file (optionally <code>
2142            <code>null</code></code>)
2143            * @param description the file's new description
2144            * @param changeLog the file's version change log (optionally
2145            <code>null</code>)
2146            * @param majorVersion whether the new file version is a major version
2147            * @param bytes the file's data (optionally <code>null</code>)
2148            * @param serviceContext the service context to be applied. Can set the
2149            asset category IDs, asset tag names, and expando bridge
2150            attributes for the file entry. In a Liferay repository, it may
2151            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
2152            type </li> <li> fieldsMap - mapping for fields associated with a
2153            custom file entry type </li> </ul>
2154            * @return the file entry
2155            * @throws PortalException if the file entry could not be found
2156            * @throws SystemException if a system exception occurred
2157            */
2158            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(
2159                    long fileEntryId, java.lang.String sourceFileName,
2160                    java.lang.String mimeType, java.lang.String title,
2161                    java.lang.String description, java.lang.String changeLog,
2162                    boolean majorVersion, byte[] bytes,
2163                    com.liferay.portal.service.ServiceContext serviceContext)
2164                    throws com.liferay.portal.kernel.exception.PortalException,
2165                            com.liferay.portal.kernel.exception.SystemException {
2166                    return _dlAppService.updateFileEntry(fileEntryId, sourceFileName,
2167                            mimeType, title, description, changeLog, majorVersion, bytes,
2168                            serviceContext);
2169            }
2170    
2171            /**
2172            * Updates a file entry and associated metadata based on a {@link
2173            * java.io.File} object. If the file data is <code>null</code>, then only
2174            * the associated metadata (i.e., <code>title</code>,
2175            * <code>description</code>, and parameters in the
2176            * <code>serviceContext</code>) will be updated.
2177            *
2178            * <p>
2179            * This method takes two file names, the <code>sourceFileName</code> and the
2180            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
2181            * name of the actual file being uploaded. The <code>title</code>
2182            * corresponds to a name the client wishes to assign this file after it has
2183            * been uploaded to the portal.
2184            * </p>
2185            *
2186            * @param fileEntryId the primary key of the file entry
2187            * @param sourceFileName the original file's name (optionally
2188            <code>null</code>)
2189            * @param mimeType the file's MIME type (optionally <code>null</code>)
2190            * @param title the new name to be assigned to the file (optionally <code>
2191            <code>null</code></code>)
2192            * @param description the file's new description
2193            * @param changeLog the file's version change log (optionally
2194            <code>null</code>)
2195            * @param majorVersion whether the new file version is a major version
2196            * @param file EntryId the primary key of the file entry
2197            * @param serviceContext the service context to be applied. Can set the
2198            asset category IDs, asset tag names, and expando bridge
2199            attributes for the file entry. In a Liferay repository, it may
2200            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
2201            type </li> <li> fieldsMap - mapping for fields associated with a
2202            custom file entry type </li> </ul>
2203            * @return the file entry
2204            * @throws PortalException if the file entry could not be found
2205            * @throws SystemException if a system exception occurred
2206            */
2207            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(
2208                    long fileEntryId, java.lang.String sourceFileName,
2209                    java.lang.String mimeType, java.lang.String title,
2210                    java.lang.String description, java.lang.String changeLog,
2211                    boolean majorVersion, java.io.File file,
2212                    com.liferay.portal.service.ServiceContext serviceContext)
2213                    throws com.liferay.portal.kernel.exception.PortalException,
2214                            com.liferay.portal.kernel.exception.SystemException {
2215                    return _dlAppService.updateFileEntry(fileEntryId, sourceFileName,
2216                            mimeType, title, description, changeLog, majorVersion, file,
2217                            serviceContext);
2218            }
2219    
2220            /**
2221            * Updates a file entry and associated metadata based on an {@link java.io.
2222            * InputStream} object. If the file data is <code>null</code>, then only the
2223            * associated metadata (i.e., <code>title</code>, <code>description</code>,
2224            * and parameters in the <code>serviceContext</code>) will be updated.
2225            *
2226            * <p>
2227            * This method takes two file names, the <code>sourceFileName</code> and the
2228            * <code>title</code>. The <code>sourceFileName</code> corresponds to the
2229            * name of the actual file being uploaded. The <code>title</code>
2230            * corresponds to a name the client wishes to assign this file after it has
2231            * been uploaded to the portal.
2232            * </p>
2233            *
2234            * @param fileEntryId the primary key of the file entry
2235            * @param sourceFileName the original file's name (optionally
2236            <code>null</code>)
2237            * @param mimeType the file's MIME type (optionally <code>null</code>)
2238            * @param title the new name to be assigned to the file (optionally <code>
2239            <code>null</code></code>)
2240            * @param description the file's new description
2241            * @param changeLog the file's version change log (optionally
2242            <code>null</code>)
2243            * @param majorVersion whether the new file version is a major version
2244            * @param is the file's data (optionally <code>null</code>)
2245            * @param size the file's size (optionally <code>0</code>)
2246            * @param serviceContext the service context to be applied. Can set the
2247            asset category IDs, asset tag names, and expando bridge
2248            attributes for the file entry. In a Liferay repository, it may
2249            include:  <ul> <li> fileEntryTypeId - ID for a custom file entry
2250            type </li> <li> fieldsMap - mapping for fields associated with a
2251            custom file entry type </li> </ul>
2252            * @return the file entry
2253            * @throws PortalException if the file entry could not be found
2254            * @throws SystemException if a system exception occurred
2255            */
2256            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(
2257                    long fileEntryId, java.lang.String sourceFileName,
2258                    java.lang.String mimeType, java.lang.String title,
2259                    java.lang.String description, java.lang.String changeLog,
2260                    boolean majorVersion, java.io.InputStream is, long size,
2261                    com.liferay.portal.service.ServiceContext serviceContext)
2262                    throws com.liferay.portal.kernel.exception.PortalException,
2263                            com.liferay.portal.kernel.exception.SystemException {
2264                    return _dlAppService.updateFileEntry(fileEntryId, sourceFileName,
2265                            mimeType, title, description, changeLog, majorVersion, is, size,
2266                            serviceContext);
2267            }
2268    
2269            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn(
2270                    long fileEntryId, java.lang.String sourceFileName,
2271                    java.lang.String mimeType, java.lang.String title,
2272                    java.lang.String description, java.lang.String changeLog,
2273                    boolean majorVersion, java.io.File file,
2274                    com.liferay.portal.service.ServiceContext serviceContext)
2275                    throws com.liferay.portal.kernel.exception.PortalException,
2276                            com.liferay.portal.kernel.exception.SystemException {
2277                    return _dlAppService.updateFileEntryAndCheckIn(fileEntryId,
2278                            sourceFileName, mimeType, title, description, changeLog,
2279                            majorVersion, file, serviceContext);
2280            }
2281    
2282            public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntryAndCheckIn(
2283                    long fileEntryId, java.lang.String sourceFileName,
2284                    java.lang.String mimeType, java.lang.String title,
2285                    java.lang.String description, java.lang.String changeLog,
2286                    boolean majorVersion, java.io.InputStream is, long size,
2287                    com.liferay.portal.service.ServiceContext serviceContext)
2288                    throws com.liferay.portal.kernel.exception.PortalException,
2289                            com.liferay.portal.kernel.exception.SystemException {
2290                    return _dlAppService.updateFileEntryAndCheckIn(fileEntryId,
2291                            sourceFileName, mimeType, title, description, changeLog,
2292                            majorVersion, is, size, serviceContext);
2293            }
2294    
2295            /**
2296            * Updates a file shortcut to the existing file entry. This method is only
2297            * supported by the Liferay repository.
2298            *
2299            * @param fileShortcutId the primary key of the file shortcut
2300            * @param folderId the primary key of the file shortcut's parent folder
2301            * @param toFileEntryId the primary key of the file shortcut's file entry
2302            * @param serviceContext the service context to be applied. Can set the
2303            asset category IDs, asset tag names, and expando bridge
2304            attributes for the file entry.
2305            * @return the file shortcut
2306            * @throws PortalException if the file shortcut, folder, or file entry could
2307            not be found
2308            * @throws SystemException if a system exception occurred
2309            */
2310            public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
2311                    long fileShortcutId, long folderId, long toFileEntryId,
2312                    com.liferay.portal.service.ServiceContext serviceContext)
2313                    throws com.liferay.portal.kernel.exception.PortalException,
2314                            com.liferay.portal.kernel.exception.SystemException {
2315                    return _dlAppService.updateFileShortcut(fileShortcutId, folderId,
2316                            toFileEntryId, serviceContext);
2317            }
2318    
2319            /**
2320            * Updates the folder.
2321            *
2322            * @param folderId the primary key of the folder
2323            * @param name the folder's new name
2324            * @param description the folder's new description
2325            * @param serviceContext the service context to be applied. In a Liferay
2326            repository, it may include:  <ul> <li> defaultFileEntryTypeId -
2327            the file entry type to default all Liferay file entries to </li>
2328            <li> dlFileEntryTypesSearchContainerPrimaryKeys - a
2329            comma-delimited list of file entry type primary keys allowed in
2330            the given folder and all descendants </li> <li>
2331            overrideFileEntryTypes - boolean specifying whether to override
2332            ancestral folder's restriction of file entry types allowed </li>
2333            <li> workflowDefinitionXYZ - the workflow definition name
2334            specified per file entry type. The parameter name must be the
2335            string <code>workflowDefinition</code> appended by the <code>
2336            fileEntryTypeId</code> (optionally <code>0</code>). </li> </ul>
2337            * @return the folder
2338            * @throws PortalException if the current or new parent folder could not be
2339            found or if the new parent folder's information was invalid
2340            * @throws SystemException if a system exception occurred
2341            */
2342            public com.liferay.portal.kernel.repository.model.Folder updateFolder(
2343                    long folderId, java.lang.String name, java.lang.String description,
2344                    com.liferay.portal.service.ServiceContext serviceContext)
2345                    throws com.liferay.portal.kernel.exception.PortalException,
2346                            com.liferay.portal.kernel.exception.SystemException {
2347                    return _dlAppService.updateFolder(folderId, name, description,
2348                            serviceContext);
2349            }
2350    
2351            /**
2352            * Returns <code>true</code> if the file entry is checked out. This method
2353            * is primarily used by WebDAV.
2354            *
2355            * @param repositoryId the primary key for the repository
2356            * @param fileEntryId the primary key for the file entry
2357            * @param lockUuid the lock's UUID
2358            * @return <code>true</code> if the file entry is checked out;
2359            <code>false</code> otherwise
2360            * @throws PortalException if the file entry could not be found
2361            * @throws SystemException if a system exception occurred
2362            */
2363            public boolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId,
2364                    java.lang.String lockUuid)
2365                    throws com.liferay.portal.kernel.exception.PortalException,
2366                            com.liferay.portal.kernel.exception.SystemException {
2367                    return _dlAppService.verifyFileEntryCheckOut(repositoryId, fileEntryId,
2368                            lockUuid);
2369            }
2370    
2371            public boolean verifyFileEntryLock(long repositoryId, long fileEntryId,
2372                    java.lang.String lockUuid)
2373                    throws com.liferay.portal.kernel.exception.PortalException,
2374                            com.liferay.portal.kernel.exception.SystemException {
2375                    return _dlAppService.verifyFileEntryLock(repositoryId, fileEntryId,
2376                            lockUuid);
2377            }
2378    
2379            /**
2380            * Returns <code>true</code> if the inheritable lock exists. This method is
2381            * primarily used by WebDAV.
2382            *
2383            * @param repositoryId the primary key for the repository
2384            * @param folderId the primary key for the folder
2385            * @param lockUuid the lock's UUID
2386            * @return <code>true</code> if the inheritable lock exists;
2387            <code>false</code> otherwise
2388            * @throws PortalException if the folder could not be found
2389            * @throws SystemException if a system exception occurred
2390            */
2391            public boolean verifyInheritableLock(long repositoryId, long folderId,
2392                    java.lang.String lockUuid)
2393                    throws com.liferay.portal.kernel.exception.PortalException,
2394                            com.liferay.portal.kernel.exception.SystemException {
2395                    return _dlAppService.verifyInheritableLock(repositoryId, folderId,
2396                            lockUuid);
2397            }
2398    
2399            /**
2400             * @deprecated Renamed to {@link #getWrappedService}
2401             */
2402            public DLAppService getWrappedDLAppService() {
2403                    return _dlAppService;
2404            }
2405    
2406            /**
2407             * @deprecated Renamed to {@link #setWrappedService}
2408             */
2409            public void setWrappedDLAppService(DLAppService dlAppService) {
2410                    _dlAppService = dlAppService;
2411            }
2412    
2413            public DLAppService getWrappedService() {
2414                    return _dlAppService;
2415            }
2416    
2417            public void setWrappedService(DLAppService dlAppService) {
2418                    _dlAppService = dlAppService;
2419            }
2420    
2421            private DLAppService _dlAppService;
2422    }