001    /**
002     * Copyright (c) 2000-2011 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 com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
074                    long folderId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
079            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
080                    long groupId, long parentFolderId, java.lang.String name)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
085            public long[] getFolderIds(long groupId, long folderId)
086                    throws com.liferay.portal.kernel.exception.SystemException;
087    
088            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
089            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
090                    long groupId, long parentFolderId, boolean includeMountfolders,
091                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
095            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
096                    long groupId, long parentFolderId, int start, int end,
097                    com.liferay.portal.kernel.util.OrderByComparator obc)
098                    throws com.liferay.portal.kernel.exception.SystemException;
099    
100            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
101            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
102                    long groupId, long folderId, int status, boolean includeMountFolders,
103                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
107            public int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
108                    long folderId, int status, java.lang.String[] mimeTypes,
109                    boolean includeMountFolders)
110                    throws com.liferay.portal.kernel.exception.SystemException;
111    
112            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
114                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
115                    boolean includeMountFolders, int start, int end,
116                    com.liferay.portal.kernel.util.OrderByComparator obc)
117                    throws com.liferay.portal.kernel.exception.SystemException;
118    
119            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
121                    long folderId, int status, boolean includeMountFolders)
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, java.lang.String[] mimeTypes,
127                    boolean includeMountFolders)
128                    throws com.liferay.portal.kernel.exception.SystemException;
129    
130            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
131            public int getFoldersCount(long groupId, long parentFolderId)
132                    throws com.liferay.portal.kernel.exception.SystemException;
133    
134            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
135            public int getFoldersCount(long groupId, long parentFolderId,
136                    boolean includeMountfolders)
137                    throws com.liferay.portal.kernel.exception.SystemException;
138    
139            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
141                    long groupId, long parentFolderId, int start, int end,
142                    com.liferay.portal.kernel.util.OrderByComparator obc)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
146            public int getMountFoldersCount(long groupId, long parentFolderId)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
151                    long groupId, long folderId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public java.util.List<java.lang.Long> getSubfolderIds(long groupId,
156                    long folderId, boolean recurse)
157                    throws com.liferay.portal.kernel.exception.SystemException;
158    
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public boolean hasFolderLock(long folderId)
161                    throws com.liferay.portal.kernel.exception.PortalException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public boolean hasInheritableLock(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 isFolderLocked(long folderId)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            public com.liferay.portal.model.Lock lockFolder(long folderId)
174                    throws com.liferay.portal.kernel.exception.PortalException,
175                            com.liferay.portal.kernel.exception.SystemException;
176    
177            public com.liferay.portal.model.Lock lockFolder(long folderId,
178                    java.lang.String owner, boolean inheritable, long expirationTime)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException;
181    
182            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
183                    long folderId, long parentFolderId,
184                    com.liferay.portal.service.ServiceContext serviceContext)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException;
187    
188            public com.liferay.portal.model.Lock refreshFolderLock(
189                    java.lang.String lockUuid, long expirationTime)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException;
192    
193            public void unlockFolder(long groupId, long folderId,
194                    java.lang.String lockUuid)
195                    throws com.liferay.portal.kernel.exception.PortalException,
196                            com.liferay.portal.kernel.exception.SystemException;
197    
198            public void unlockFolder(long groupId, long parentFolderId,
199                    java.lang.String name, java.lang.String lockUuid)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
204                    long folderId, java.lang.String name, java.lang.String description,
205                    long defaultFileEntryTypeId,
206                    java.util.List<java.lang.Long> fileEntryTypeIds,
207                    boolean overrideFileEntryTypes,
208                    com.liferay.portal.service.ServiceContext serviceContext)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException;
211    
212            public boolean verifyInheritableLock(long folderId,
213                    java.lang.String lockUuid)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException;
216    }