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