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 document library folder 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 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    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface DLFolderService extends BaseService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * 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.
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            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
065                    long groupId, long repositoryId, boolean mountPoint,
066                    long parentFolderId, java.lang.String name,
067                    java.lang.String description,
068                    com.liferay.portal.service.ServiceContext serviceContext)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public void deleteFolder(long folderId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            public void deleteFolder(long folderId, boolean includeTrashedEntries)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            public void deleteFolder(long groupId, long parentFolderId,
081                    java.lang.String name)
082                    throws com.liferay.portal.kernel.exception.PortalException,
083                            com.liferay.portal.kernel.exception.SystemException;
084    
085            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
086            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
087                    long groupId, long folderId, int status, int start, int end)
088                    throws com.liferay.portal.kernel.exception.PortalException,
089                            com.liferay.portal.kernel.exception.SystemException;
090    
091            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
092            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
093                    int status) throws com.liferay.portal.kernel.exception.SystemException;
094    
095            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
096            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
097                    int status, java.lang.String[] mimeTypes)
098                    throws com.liferay.portal.kernel.exception.SystemException;
099    
100            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
101            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
102                    long folderId)
103                    throws com.liferay.portal.kernel.exception.PortalException,
104                            com.liferay.portal.kernel.exception.SystemException;
105    
106            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
107            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
108                    long groupId, long parentFolderId, java.lang.String name)
109                    throws com.liferay.portal.kernel.exception.PortalException,
110                            com.liferay.portal.kernel.exception.SystemException;
111    
112            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113            public java.util.List<java.lang.Long> getFolderIds(long groupId,
114                    long folderId)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException;
117    
118            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
119            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
120                    long groupId, long parentFolderId, int status,
121                    boolean includeMountfolders, int start, int end,
122                    com.liferay.portal.kernel.util.OrderByComparator obc)
123                    throws com.liferay.portal.kernel.exception.PortalException,
124                            com.liferay.portal.kernel.exception.SystemException;
125    
126            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
128                    long groupId, long parentFolderId, int start, int end,
129                    com.liferay.portal.kernel.util.OrderByComparator obc)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException;
132    
133            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
134            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
135                    long groupId, long folderId, int status, boolean includeMountFolders,
136                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
137                    throws com.liferay.portal.kernel.exception.PortalException,
138                            com.liferay.portal.kernel.exception.SystemException;
139    
140            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
141            public int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
142                    long folderId, int status, java.lang.String[] mimeTypes,
143                    boolean includeMountFolders)
144                    throws com.liferay.portal.kernel.exception.PortalException,
145                            com.liferay.portal.kernel.exception.SystemException;
146    
147            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
148            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
149                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
150                    boolean includeMountFolders, int start, int end,
151                    com.liferay.portal.kernel.util.OrderByComparator obc)
152                    throws com.liferay.portal.kernel.exception.PortalException,
153                            com.liferay.portal.kernel.exception.SystemException;
154    
155            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
156            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
157                    long folderId, int status, boolean includeMountFolders)
158                    throws com.liferay.portal.kernel.exception.SystemException;
159    
160            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
161            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
162                    long folderId, int status, java.lang.String[] mimeTypes,
163                    boolean includeMountFolders)
164                    throws com.liferay.portal.kernel.exception.SystemException;
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public int getFoldersCount(long groupId, long parentFolderId)
168                    throws 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.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
177                    long groupId, long parentFolderId, int start, int end,
178                    com.liferay.portal.kernel.util.OrderByComparator obc)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException;
181    
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public int getMountFoldersCount(long groupId, long parentFolderId)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
188                    long groupId, long folderId)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException;
191    
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public java.util.List<java.lang.Long> getSubfolderIds(long groupId,
194                    long folderId, boolean recurse)
195                    throws com.liferay.portal.kernel.exception.PortalException,
196                            com.liferay.portal.kernel.exception.SystemException;
197    
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public boolean hasFolderLock(long folderId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public boolean hasInheritableLock(long folderId)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException;
207    
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public boolean isFolderLocked(long folderId)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            public com.liferay.portal.model.Lock lockFolder(long folderId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            public com.liferay.portal.model.Lock lockFolder(long folderId,
217                    java.lang.String owner, boolean inheritable, long expirationTime)
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
222                    long folderId, long parentFolderId,
223                    com.liferay.portal.service.ServiceContext serviceContext)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            public com.liferay.portal.model.Lock refreshFolderLock(
228                    java.lang.String lockUuid, long companyId, long expirationTime)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException;
231    
232            public void unlockFolder(long groupId, long parentFolderId,
233                    java.lang.String name, java.lang.String lockUuid)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            public void unlockFolder(long folderId, java.lang.String lockUuid)
238                    throws com.liferay.portal.kernel.exception.PortalException,
239                            com.liferay.portal.kernel.exception.SystemException;
240    
241            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
242                    long folderId, java.lang.String name, java.lang.String description,
243                    long defaultFileEntryTypeId,
244                    java.util.List<java.lang.Long> fileEntryTypeIds,
245                    boolean overrideFileEntryTypes,
246                    com.liferay.portal.service.ServiceContext serviceContext)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException;
249    
250            public boolean verifyInheritableLock(long folderId,
251                    java.lang.String lockUuid)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    }