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