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    
024    /**
025     * The interface for the document library folder remote service.
026     *
027     * <p>
028     * 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.
029     * </p>
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    @JSONWebService
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface DLFolderService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * 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.
045             */
046            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
047                    long groupId, long repositoryId, boolean mountPoint,
048                    long parentFolderId, java.lang.String name,
049                    java.lang.String description,
050                    com.liferay.portal.service.ServiceContext serviceContext)
051                    throws com.liferay.portal.kernel.exception.PortalException,
052                            com.liferay.portal.kernel.exception.SystemException;
053    
054            public void deleteFolder(long folderId)
055                    throws com.liferay.portal.kernel.exception.PortalException,
056                            com.liferay.portal.kernel.exception.SystemException;
057    
058            public void deleteFolder(long groupId, long parentFolderId,
059                    java.lang.String name)
060                    throws com.liferay.portal.kernel.exception.PortalException,
061                            com.liferay.portal.kernel.exception.SystemException;
062    
063            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
064            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
065                    long groupId, long folderId, int status, int start, int end)
066                    throws com.liferay.portal.kernel.exception.SystemException;
067    
068            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
069            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
070                    int status) throws com.liferay.portal.kernel.exception.SystemException;
071    
072            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
073            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
074                    int status, java.lang.String[] mimeTypes)
075                    throws com.liferay.portal.kernel.exception.SystemException;
076    
077            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
078            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
079                    long folderId)
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 com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
085                    long groupId, long parentFolderId, java.lang.String name)
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 long[] getFolderIds(long groupId, long folderId)
091                    throws com.liferay.portal.kernel.exception.SystemException;
092    
093            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
094            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
095                    long groupId, long parentFolderId, boolean includeMountfolders,
096                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
100            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
101                    long groupId, long parentFolderId, int start, int end,
102                    com.liferay.portal.kernel.util.OrderByComparator obc)
103                    throws com.liferay.portal.kernel.exception.SystemException;
104    
105            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
107                    long groupId, long folderId, int status, boolean includeMountFolders,
108                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
109                    throws com.liferay.portal.kernel.exception.SystemException;
110    
111            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
112            public int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
113                    long folderId, int status, java.lang.String[] mimeTypes,
114                    boolean includeMountFolders)
115                    throws com.liferay.portal.kernel.exception.SystemException;
116    
117            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
118            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
119                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
120                    boolean includeMountFolders, int start, int end,
121                    com.liferay.portal.kernel.util.OrderByComparator obc)
122                    throws com.liferay.portal.kernel.exception.SystemException;
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
126                    long folderId, int status, boolean includeMountFolders)
127                    throws com.liferay.portal.kernel.exception.SystemException;
128    
129            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
131                    long folderId, int status, java.lang.String[] mimeTypes,
132                    boolean includeMountFolders)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136            public int getFoldersCount(long groupId, long parentFolderId)
137                    throws com.liferay.portal.kernel.exception.SystemException;
138    
139            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140            public int getFoldersCount(long groupId, long parentFolderId,
141                    boolean includeMountfolders)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
146                    long groupId, long parentFolderId, int start, int end,
147                    com.liferay.portal.kernel.util.OrderByComparator obc)
148                    throws com.liferay.portal.kernel.exception.SystemException;
149    
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public int getMountFoldersCount(long groupId, long parentFolderId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
156                    long groupId, long folderId)
157                    throws com.liferay.portal.kernel.exception.SystemException;
158    
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public java.util.List<java.lang.Long> getSubfolderIds(long groupId,
161                    long folderId, boolean recurse)
162                    throws com.liferay.portal.kernel.exception.SystemException;
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public boolean hasFolderLock(long folderId)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public boolean hasInheritableLock(long folderId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public boolean isFolderLocked(long folderId)
176                    throws com.liferay.portal.kernel.exception.SystemException;
177    
178            public com.liferay.portal.model.Lock lockFolder(long folderId)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException;
181    
182            public com.liferay.portal.model.Lock lockFolder(long folderId,
183                    java.lang.String owner, boolean inheritable, long expirationTime)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException;
186    
187            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
188                    long folderId, long parentFolderId,
189                    com.liferay.portal.service.ServiceContext serviceContext)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException;
192    
193            public com.liferay.portal.model.Lock refreshFolderLock(
194                    java.lang.String lockUuid, long expirationTime)
195                    throws com.liferay.portal.kernel.exception.PortalException,
196                            com.liferay.portal.kernel.exception.SystemException;
197    
198            public void unlockFolder(long groupId, long folderId,
199                    java.lang.String lockUuid)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            public void unlockFolder(long groupId, long parentFolderId,
204                    java.lang.String name, java.lang.String lockUuid)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException;
207    
208            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
209                    long folderId, java.lang.String name, java.lang.String description,
210                    long defaultFileEntryTypeId,
211                    java.util.List<java.lang.Long> fileEntryTypeIds,
212                    boolean overrideFileEntryTypes,
213                    com.liferay.portal.service.ServiceContext serviceContext)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException;
216    
217            public boolean verifyInheritableLock(long folderId,
218                    java.lang.String lockUuid)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    }