001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 d l 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 d l 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 parentFolderId, java.lang.String name,
048                    java.lang.String description,
049                    com.liferay.portal.service.ServiceContext serviceContext)
050                    throws com.liferay.portal.kernel.exception.PortalException,
051                            com.liferay.portal.kernel.exception.SystemException;
052    
053            public com.liferay.portlet.documentlibrary.model.DLFolder copyFolder(
054                    long groupId, long sourceFolderId, long parentFolderId,
055                    java.lang.String name, java.lang.String description,
056                    com.liferay.portal.service.ServiceContext serviceContext)
057                    throws com.liferay.portal.kernel.exception.PortalException,
058                            com.liferay.portal.kernel.exception.SystemException,
059                            java.rmi.RemoteException;
060    
061            public void deleteFolder(long folderId)
062                    throws com.liferay.portal.kernel.exception.PortalException,
063                            com.liferay.portal.kernel.exception.SystemException,
064                            java.rmi.RemoteException;
065    
066            public void deleteFolder(long groupId, long parentFolderId,
067                    java.lang.String name)
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException,
070                            java.rmi.RemoteException;
071    
072            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
073            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
074                    long groupId, java.util.List<java.lang.Long> folderIds, int status,
075                    int start, int end)
076                    throws com.liferay.portal.kernel.exception.SystemException;
077    
078            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
079            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
080                    long groupId, long folderId, int status, int start, int end)
081                    throws com.liferay.portal.kernel.exception.SystemException;
082    
083            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
084            public int getFileEntriesAndFileShortcutsCount(long groupId,
085                    java.util.List<java.lang.Long> folderIds, int status)
086                    throws com.liferay.portal.kernel.exception.SystemException;
087    
088            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
089            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
090                    int status) throws com.liferay.portal.kernel.exception.SystemException;
091    
092            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
093            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
094                    long folderId)
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException;
097    
098            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
099            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
100                    long groupId, long parentFolderId, java.lang.String name)
101                    throws com.liferay.portal.kernel.exception.PortalException,
102                            com.liferay.portal.kernel.exception.SystemException;
103    
104            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
105            public long getFolderId(long groupId, long parentFolderId,
106                    java.lang.String name)
107                    throws com.liferay.portal.kernel.exception.PortalException,
108                            com.liferay.portal.kernel.exception.SystemException;
109    
110            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111            public long[] getFolderIds(long groupId, long folderId)
112                    throws com.liferay.portal.kernel.exception.SystemException;
113    
114            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
116                    long groupId, long parentFolderId)
117                    throws 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 start, int end)
122                    throws com.liferay.portal.kernel.exception.SystemException;
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
126                    long groupId, java.util.List<java.lang.Long> folderIds, int status,
127                    int start, int end)
128                    throws com.liferay.portal.kernel.exception.SystemException;
129    
130            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
131            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
132                    long groupId, long folderId, int status, int start, int end)
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException;
135    
136            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
138                    java.util.List<java.lang.Long> folderIds, int status)
139                    throws com.liferay.portal.kernel.exception.SystemException;
140    
141            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
143                    long folderId, int status)
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 int getFoldersCount(long groupId, long parentFolderId)
149                    throws com.liferay.portal.kernel.exception.SystemException;
150    
151            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
152            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
153                    long groupId, long folderId)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
158                    long groupId, long folderId, boolean recurse)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162            public boolean hasInheritableLock(long folderId)
163                    throws com.liferay.portal.kernel.exception.PortalException,
164                            com.liferay.portal.kernel.exception.SystemException;
165    
166            public com.liferay.portal.model.Lock lockFolder(long folderId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException,
169                            java.rmi.RemoteException;
170    
171            public com.liferay.portal.model.Lock lockFolder(long folderId,
172                    java.lang.String owner, boolean inheritable, long expirationTime)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException,
175                            java.rmi.RemoteException;
176    
177            public com.liferay.portal.model.Lock refreshFolderLock(
178                    java.lang.String lockUuid, long expirationTime)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException;
181    
182            public void unlockFolder(long groupId, long folderId,
183                    java.lang.String lockUuid)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException;
186    
187            public void unlockFolder(long groupId, long parentFolderId,
188                    java.lang.String name, java.lang.String lockUuid)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException;
191    
192            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
193                    long folderId, long parentFolderId, java.lang.String name,
194                    java.lang.String description,
195                    com.liferay.portal.service.ServiceContext serviceContext)
196                    throws com.liferay.portal.kernel.exception.PortalException,
197                            com.liferay.portal.kernel.exception.SystemException,
198                            java.rmi.RemoteException;
199    
200            public boolean verifyInheritableLock(long folderId,
201                    java.lang.String lockUuid)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    }