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 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    @ProviderType
040    @AccessControlled
041    @JSONWebService
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    
051            /**
052            * Returns the Spring bean ID for this bean.
053            *
054            * @return the Spring bean ID for this bean
055            */
056            public java.lang.String getBeanIdentifier();
057    
058            /**
059            * Sets the Spring bean ID for this bean.
060            *
061            * @param beanIdentifier the Spring bean ID for this bean
062            */
063            public void setBeanIdentifier(java.lang.String beanIdentifier);
064    
065            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
066                    long groupId, long repositoryId, boolean mountPoint,
067                    long parentFolderId, java.lang.String name,
068                    java.lang.String description,
069                    com.liferay.portal.service.ServiceContext serviceContext)
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            public void deleteFolder(long folderId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            public void deleteFolder(long folderId, boolean includeTrashedEntries)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            public void deleteFolder(long groupId, long parentFolderId,
082                    java.lang.String name)
083                    throws com.liferay.portal.kernel.exception.PortalException,
084                            com.liferay.portal.kernel.exception.SystemException;
085    
086            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
087            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
088                    long groupId, long folderId, int status, int start, int end)
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException;
091    
092            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
093            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
094                    int status)
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException;
097    
098            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
099            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
100                    int status, java.lang.String[] mimeTypes)
101                    throws com.liferay.portal.kernel.exception.PortalException,
102                            com.liferay.portal.kernel.exception.SystemException;
103    
104            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
105            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
106                    long folderId)
107                    throws com.liferay.portal.kernel.exception.PortalException,
108                            com.liferay.portal.kernel.exception.SystemException;
109    
110            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
112                    long groupId, long parentFolderId, java.lang.String name)
113                    throws com.liferay.portal.kernel.exception.PortalException,
114                            com.liferay.portal.kernel.exception.SystemException;
115    
116            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117            public java.util.List<java.lang.Long> getFolderIds(long groupId,
118                    long folderId)
119                    throws com.liferay.portal.kernel.exception.PortalException,
120                            com.liferay.portal.kernel.exception.SystemException;
121    
122            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
123            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
124                    long groupId, long parentFolderId, int status,
125                    boolean includeMountfolders, int start, int end,
126                    com.liferay.portal.kernel.util.OrderByComparator obc)
127                    throws com.liferay.portal.kernel.exception.PortalException,
128                            com.liferay.portal.kernel.exception.SystemException;
129    
130            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
131            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
132                    long groupId, long parentFolderId, int start, int end,
133                    com.liferay.portal.kernel.util.OrderByComparator obc)
134                    throws com.liferay.portal.kernel.exception.PortalException,
135                            com.liferay.portal.kernel.exception.SystemException;
136    
137            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
138            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
139                    long groupId, long folderId, int status, boolean includeMountFolders,
140                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
141                    throws com.liferay.portal.kernel.exception.PortalException,
142                            com.liferay.portal.kernel.exception.SystemException;
143    
144            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
146                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
147                    boolean includeMountFolders, int start, int end,
148                    com.liferay.portal.kernel.util.OrderByComparator obc)
149                    throws com.liferay.portal.kernel.exception.PortalException,
150                            com.liferay.portal.kernel.exception.SystemException;
151    
152            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
153            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
154                    long folderId, int status, boolean includeMountFolders)
155                    throws com.liferay.portal.kernel.exception.PortalException,
156                            com.liferay.portal.kernel.exception.SystemException;
157    
158            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
159            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
160                    long folderId, int status, java.lang.String[] mimeTypes,
161                    boolean includeMountFolders)
162                    throws com.liferay.portal.kernel.exception.PortalException,
163                            com.liferay.portal.kernel.exception.SystemException;
164    
165            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
166            public int getFoldersCount(long groupId, long parentFolderId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public int getFoldersCount(long groupId, long parentFolderId, int status,
172                    boolean includeMountfolders)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException;
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
178                    long groupId, long parentFolderId, int start, int end,
179                    com.liferay.portal.kernel.util.OrderByComparator obc)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException;
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public int getMountFoldersCount(long groupId, long parentFolderId)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException;
187    
188            /**
189            * @deprecated As of 7.0.0, replaced by {@link #getSubfolderIds(List, long,
190            long, boolean)}
191            */
192            @Deprecated
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
195                    long groupId, long folderId)
196                    throws com.liferay.portal.kernel.exception.PortalException,
197                            com.liferay.portal.kernel.exception.SystemException;
198    
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
201                    long groupId, long folderId, boolean recurse)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<java.lang.Long> getSubfolderIds(long groupId,
207                    long folderId, boolean recurse)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException;
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public boolean hasFolderLock(long folderId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public boolean hasInheritableLock(long folderId)
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public boolean isFolderLocked(long folderId)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            public com.liferay.portal.model.Lock lockFolder(long folderId)
226                    throws com.liferay.portal.kernel.exception.PortalException,
227                            com.liferay.portal.kernel.exception.SystemException;
228    
229            public com.liferay.portal.model.Lock lockFolder(long folderId,
230                    java.lang.String owner, boolean inheritable, long expirationTime)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
235                    long folderId, long parentFolderId,
236                    com.liferay.portal.service.ServiceContext serviceContext)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException;
239    
240            public com.liferay.portal.model.Lock refreshFolderLock(
241                    java.lang.String lockUuid, long companyId, long expirationTime)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException;
244    
245            public void unlockFolder(long groupId, long parentFolderId,
246                    java.lang.String name, java.lang.String lockUuid)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            public void unlockFolder(long folderId, java.lang.String lockUuid)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
255                    long folderId, java.lang.String name, java.lang.String description,
256                    long defaultFileEntryTypeId,
257                    java.util.List<java.lang.Long> fileEntryTypeIds,
258                    boolean overrideFileEntryTypes,
259                    com.liferay.portal.service.ServiceContext serviceContext)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            public boolean verifyInheritableLock(long folderId,
264                    java.lang.String lockUuid)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    }