001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the d l folder remote service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see DLFolderServiceUtil
036     * @see com.liferay.portlet.documentlibrary.service.base.DLFolderServiceBaseImpl
037     * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface DLFolderService {
043            public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
044                    long groupId, long parentFolderId, java.lang.String name,
045                    java.lang.String description,
046                    com.liferay.portal.service.ServiceContext serviceContext)
047                    throws com.liferay.portal.kernel.exception.PortalException,
048                            com.liferay.portal.kernel.exception.SystemException;
049    
050            public com.liferay.portlet.documentlibrary.model.DLFolder copyFolder(
051                    long groupId, long sourceFolderId, long parentFolderId,
052                    java.lang.String name, java.lang.String description,
053                    com.liferay.portal.service.ServiceContext serviceContext)
054                    throws com.liferay.portal.kernel.exception.PortalException,
055                            com.liferay.portal.kernel.exception.SystemException,
056                            java.rmi.RemoteException;
057    
058            public void deleteFolder(long folderId)
059                    throws com.liferay.portal.kernel.exception.PortalException,
060                            com.liferay.portal.kernel.exception.SystemException,
061                            java.rmi.RemoteException;
062    
063            public void deleteFolder(long groupId, long parentFolderId,
064                    java.lang.String name)
065                    throws com.liferay.portal.kernel.exception.PortalException,
066                            com.liferay.portal.kernel.exception.SystemException,
067                            java.rmi.RemoteException;
068    
069            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
070            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
071                    long groupId, java.util.List<java.lang.Long> folderIds, int status,
072                    int start, int end)
073                    throws com.liferay.portal.kernel.exception.SystemException;
074    
075            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
076            public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
077                    long groupId, long folderId, int status, int start, int end)
078                    throws com.liferay.portal.kernel.exception.SystemException;
079    
080            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
081            public int getFileEntriesAndFileShortcutsCount(long groupId,
082                    java.util.List<java.lang.Long> folderIds, int status)
083                    throws com.liferay.portal.kernel.exception.SystemException;
084    
085            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
086            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
087                    int status) throws com.liferay.portal.kernel.exception.SystemException;
088    
089            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
090            public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
091                    long folderId)
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 com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
097                    long groupId, long parentFolderId, java.lang.String name)
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 long getFolderId(long groupId, long parentFolderId,
103                    java.lang.String name)
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 long[] getFolderIds(long groupId, long folderId)
109                    throws com.liferay.portal.kernel.exception.SystemException;
110    
111            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
112            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
113                    long groupId, long parentFolderId)
114                    throws com.liferay.portal.kernel.exception.SystemException;
115    
116            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
118                    long groupId, long parentFolderId, int start, int end)
119                    throws com.liferay.portal.kernel.exception.SystemException;
120    
121            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
123                    long groupId, java.util.List<java.lang.Long> folderIds, int status,
124                    int start, int end)
125                    throws com.liferay.portal.kernel.exception.SystemException;
126    
127            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
128            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
129                    long groupId, long folderId, int status, int start, int end)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException;
132    
133            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
134            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
135                    java.util.List<java.lang.Long> folderIds, int status)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
139            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
140                    long folderId, int status)
141                    throws com.liferay.portal.kernel.exception.PortalException,
142                            com.liferay.portal.kernel.exception.SystemException;
143    
144            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145            public int getFoldersCount(long groupId, long parentFolderId)
146                    throws com.liferay.portal.kernel.exception.SystemException;
147    
148            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
149            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
150                    long groupId, long folderId)
151                    throws com.liferay.portal.kernel.exception.SystemException;
152    
153            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
154            public boolean hasInheritableLock(long folderId)
155                    throws com.liferay.portal.kernel.exception.PortalException,
156                            com.liferay.portal.kernel.exception.SystemException;
157    
158            public com.liferay.portal.model.Lock lockFolder(long folderId)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException,
161                            java.rmi.RemoteException;
162    
163            public com.liferay.portal.model.Lock lockFolder(long folderId,
164                    java.lang.String owner, boolean inheritable, long expirationTime)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException,
167                            java.rmi.RemoteException;
168    
169            public com.liferay.portal.model.Lock refreshFolderLock(
170                    java.lang.String lockUuid, long expirationTime)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            public void unlockFolder(long groupId, long folderId,
175                    java.lang.String lockUuid)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException;
178    
179            public void unlockFolder(long groupId, long parentFolderId,
180                    java.lang.String name, java.lang.String lockUuid)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
185                    long folderId, long parentFolderId, java.lang.String name,
186                    java.lang.String description,
187                    com.liferay.portal.service.ServiceContext serviceContext)
188                    throws com.liferay.portal.kernel.exception.PortalException,
189                            com.liferay.portal.kernel.exception.SystemException,
190                            java.rmi.RemoteException;
191    
192            public boolean verifyInheritableLock(long folderId,
193                    java.lang.String lockUuid)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException;
196    }