001    /**
002     * Copyright (c) 2000-present 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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.security.ac.AccessControlled;
026    import com.liferay.portal.service.BaseService;
027    
028    /**
029     * Provides the remote service interface for DLFolder. Methods of this
030     * service are expected to have security checks based on the propagated JAAS
031     * credentials because this service can be accessed remotely.
032     *
033     * @author Brian Wing Shun Chan
034     * @see DLFolderServiceUtil
035     * @see com.liferay.portlet.documentlibrary.service.base.DLFolderServiceBaseImpl
036     * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl
037     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @ProviderType
042    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
043            PortalException.class, SystemException.class})
044    public interface DLFolderService extends BaseService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link DLFolderServiceUtil} to access the document library folder remote service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
051                    long groupId, long repositoryId, boolean mountPoint,
052                    long parentFolderId, java.lang.String name,
053                    java.lang.String description,
054                    com.liferay.portal.service.ServiceContext serviceContext)
055                    throws com.liferay.portal.kernel.exception.PortalException;
056    
057            public void deleteFolder(long folderId)
058                    throws com.liferay.portal.kernel.exception.PortalException;
059    
060            public void deleteFolder(long folderId, boolean includeTrashedEntries)
061                    throws com.liferay.portal.kernel.exception.PortalException;
062    
063            public void deleteFolder(long groupId, long parentFolderId,
064                    java.lang.String name)
065                    throws com.liferay.portal.kernel.exception.PortalException;
066    
067            /**
068            * Returns the Spring bean ID for this bean.
069            *
070            * @return the Spring bean ID for this bean
071            */
072            public java.lang.String getBeanIdentifier();
073    
074            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
075            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
076                    long groupId, long folderId, int status, int start, int end)
077                    throws com.liferay.portal.kernel.exception.PortalException;
078    
079            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
080            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
081                    int status) throws com.liferay.portal.kernel.exception.PortalException;
082    
083            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
084            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
085                    int status, java.lang.String[] mimeTypes)
086                    throws com.liferay.portal.kernel.exception.PortalException;
087    
088            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
089            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
090                    long folderId)
091                    throws com.liferay.portal.kernel.exception.PortalException;
092    
093            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
094            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
095                    long groupId, long parentFolderId, java.lang.String name)
096                    throws com.liferay.portal.kernel.exception.PortalException;
097    
098            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
099            public java.util.List<java.lang.Long> getFolderIds(long groupId,
100                    long folderId)
101                    throws com.liferay.portal.kernel.exception.PortalException;
102    
103            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
105                    long groupId, long parentFolderId, int start, int end,
106                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFolder> obc)
107                    throws com.liferay.portal.kernel.exception.PortalException;
108    
109            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
110            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
111                    long groupId, long parentFolderId, int status,
112                    boolean includeMountfolders, int start, int end,
113                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFolder> obc)
114                    throws com.liferay.portal.kernel.exception.PortalException;
115    
116            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
118                    long groupId, long folderId, int status, boolean includeMountFolders,
119                    int start, int end,
120                    com.liferay.portal.kernel.util.OrderByComparator<?> obc)
121                    throws com.liferay.portal.kernel.exception.PortalException;
122    
123            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
124            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
125                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
126                    boolean includeMountFolders, int start, int end,
127                    com.liferay.portal.kernel.util.OrderByComparator<?> obc)
128                    throws com.liferay.portal.kernel.exception.PortalException;
129    
130            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
131            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
132                    long folderId, int status, boolean includeMountFolders)
133                    throws com.liferay.portal.kernel.exception.PortalException;
134    
135            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
137                    long folderId, int status, java.lang.String[] mimeTypes,
138                    boolean includeMountFolders)
139                    throws com.liferay.portal.kernel.exception.PortalException;
140    
141            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142            public int getFoldersCount(long groupId, long parentFolderId)
143                    throws com.liferay.portal.kernel.exception.PortalException;
144    
145            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
146            public int getFoldersCount(long groupId, long parentFolderId, int status,
147                    boolean includeMountfolders)
148                    throws com.liferay.portal.kernel.exception.PortalException;
149    
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
152                    long groupId, long parentFolderId, int start, int end,
153                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFolder> obc)
154                    throws com.liferay.portal.kernel.exception.PortalException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public int getMountFoldersCount(long groupId, long parentFolderId)
158                    throws com.liferay.portal.kernel.exception.PortalException;
159    
160            /**
161            * @deprecated As of 7.0.0, replaced by {@link #getSubfolderIds(List, long,
162            long, boolean)}
163            */
164            @java.lang.Deprecated
165            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
166            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
167                    long groupId, long folderId)
168                    throws com.liferay.portal.kernel.exception.PortalException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
172                    long groupId, long folderId, boolean recurse)
173                    throws com.liferay.portal.kernel.exception.PortalException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public java.util.List<java.lang.Long> getSubfolderIds(long groupId,
177                    long folderId, boolean recurse)
178                    throws com.liferay.portal.kernel.exception.PortalException;
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public boolean hasFolderLock(long folderId)
182                    throws com.liferay.portal.kernel.exception.PortalException;
183    
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public boolean hasInheritableLock(long folderId)
186                    throws com.liferay.portal.kernel.exception.PortalException;
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public boolean isFolderLocked(long folderId);
190    
191            public com.liferay.portal.model.Lock lockFolder(long folderId)
192                    throws com.liferay.portal.kernel.exception.PortalException;
193    
194            public com.liferay.portal.model.Lock lockFolder(long folderId,
195                    java.lang.String owner, boolean inheritable, long expirationTime)
196                    throws com.liferay.portal.kernel.exception.PortalException;
197    
198            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
199                    long folderId, long parentFolderId,
200                    com.liferay.portal.service.ServiceContext serviceContext)
201                    throws com.liferay.portal.kernel.exception.PortalException;
202    
203            public com.liferay.portal.model.Lock refreshFolderLock(
204                    java.lang.String lockUuid, long companyId, long expirationTime)
205                    throws com.liferay.portal.kernel.exception.PortalException;
206    
207            /**
208            * Sets the Spring bean ID for this bean.
209            *
210            * @param beanIdentifier the Spring bean ID for this bean
211            */
212            public void setBeanIdentifier(java.lang.String beanIdentifier);
213    
214            public void unlockFolder(long folderId, java.lang.String lockUuid)
215                    throws com.liferay.portal.kernel.exception.PortalException;
216    
217            public void unlockFolder(long groupId, long parentFolderId,
218                    java.lang.String name, java.lang.String lockUuid)
219                    throws com.liferay.portal.kernel.exception.PortalException;
220    
221            /**
222            * @deprecated As of 7.0.0, replaced by more general {@link
223            #updateFolder(long, String, String, long, List, int,
224            ServiceContext)}
225            */
226            @java.lang.Deprecated
227            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
228                    long folderId, java.lang.String name, java.lang.String description,
229                    long defaultFileEntryTypeId,
230                    java.util.List<java.lang.Long> fileEntryTypeIds,
231                    boolean overrideFileEntryTypes,
232                    com.liferay.portal.service.ServiceContext serviceContext)
233                    throws com.liferay.portal.kernel.exception.PortalException;
234    
235            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
236                    long folderId, java.lang.String name, java.lang.String description,
237                    long defaultFileEntryTypeId,
238                    java.util.List<java.lang.Long> fileEntryTypeIds, int restrictionType,
239                    com.liferay.portal.service.ServiceContext serviceContext)
240                    throws com.liferay.portal.kernel.exception.PortalException;
241    
242            public boolean verifyInheritableLock(long folderId,
243                    java.lang.String lockUuid)
244                    throws com.liferay.portal.kernel.exception.PortalException;
245    }