001    /**
002     * Copyright (c) 2000-2012 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 long[] getFolderIds(long groupId, long folderId)
114                    throws com.liferay.portal.kernel.exception.PortalException,
115                            com.liferay.portal.kernel.exception.SystemException;
116    
117            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
118            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
119                    long groupId, long parentFolderId, int status,
120                    boolean includeMountfolders, int start, int end,
121                    com.liferay.portal.kernel.util.OrderByComparator obc)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException;
124    
125            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
126            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
127                    long groupId, long parentFolderId, int start, int end,
128                    com.liferay.portal.kernel.util.OrderByComparator obc)
129                    throws com.liferay.portal.kernel.exception.PortalException,
130                            com.liferay.portal.kernel.exception.SystemException;
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
134                    long groupId, long folderId, int status, boolean includeMountFolders,
135                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
136                    throws com.liferay.portal.kernel.exception.PortalException,
137                            com.liferay.portal.kernel.exception.SystemException;
138    
139            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140            public int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
141                    long folderId, int status, java.lang.String[] mimeTypes,
142                    boolean includeMountFolders)
143                    throws com.liferay.portal.kernel.exception.PortalException,
144                            com.liferay.portal.kernel.exception.SystemException;
145    
146            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
147            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
148                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
149                    boolean includeMountFolders, int start, int end,
150                    com.liferay.portal.kernel.util.OrderByComparator obc)
151                    throws com.liferay.portal.kernel.exception.PortalException,
152                            com.liferay.portal.kernel.exception.SystemException;
153    
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
156                    long folderId, int status, boolean includeMountFolders)
157                    throws com.liferay.portal.kernel.exception.SystemException;
158    
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
161                    long folderId, int status, java.lang.String[] mimeTypes,
162                    boolean includeMountFolders)
163                    throws 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.SystemException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public int getFoldersCount(long groupId, long parentFolderId, int status,
171                    boolean includeMountfolders)
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
176                    long groupId, long parentFolderId, int start, int end,
177                    com.liferay.portal.kernel.util.OrderByComparator obc)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public int getMountFoldersCount(long groupId, long parentFolderId)
183                    throws 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 folderId,
232                    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 groupId, long parentFolderId,
237                    java.lang.String name, 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    }