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