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.security.ac.AccessControlled;
024    import com.liferay.portal.service.BaseService;
025    
026    /**
027     * Provides the remote service interface for DLFolder. Methods of this
028     * service are expected to have security checks based on the propagated JAAS
029     * credentials because this service can be accessed remotely.
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    @AccessControlled
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 folderId, boolean includeTrashedEntries)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException;
077    
078            public void deleteFolder(long groupId, long parentFolderId,
079                    java.lang.String name)
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 java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
085                    long groupId, long folderId, int status, int start, int end)
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 int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
091                    int status) throws com.liferay.portal.kernel.exception.SystemException;
092    
093            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
094            public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
095                    int status, java.lang.String[] mimeTypes)
096                    throws 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 folderId)
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 com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
106                    long groupId, long parentFolderId, 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 java.util.List<java.lang.Long> getFolderIds(long groupId,
112                    long folderId)
113                    throws com.liferay.portal.kernel.exception.PortalException,
114                            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 status,
119                    boolean includeMountfolders, int start, int end,
120                    com.liferay.portal.kernel.util.OrderByComparator obc)
121                    throws com.liferay.portal.kernel.exception.PortalException,
122                            com.liferay.portal.kernel.exception.SystemException;
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
126                    long groupId, long parentFolderId, int start, int end,
127                    com.liferay.portal.kernel.util.OrderByComparator obc)
128                    throws com.liferay.portal.kernel.exception.PortalException,
129                            com.liferay.portal.kernel.exception.SystemException;
130    
131            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
132            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
133                    long groupId, long folderId, int status, boolean includeMountFolders,
134                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
135                    throws com.liferay.portal.kernel.exception.PortalException,
136                            com.liferay.portal.kernel.exception.SystemException;
137    
138            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
139            public int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
140                    long folderId, int status, java.lang.String[] mimeTypes,
141                    boolean includeMountFolders)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException;
144    
145            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
146            public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
147                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
148                    boolean includeMountFolders, int start, int end,
149                    com.liferay.portal.kernel.util.OrderByComparator obc)
150                    throws com.liferay.portal.kernel.exception.PortalException,
151                            com.liferay.portal.kernel.exception.SystemException;
152    
153            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
154            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
155                    long folderId, int status, boolean includeMountFolders)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
159            public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
160                    long folderId, int status, java.lang.String[] mimeTypes,
161                    boolean includeMountFolders)
162                    throws com.liferay.portal.kernel.exception.SystemException;
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public int getFoldersCount(long groupId, long parentFolderId)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public int getFoldersCount(long groupId, long parentFolderId, int status,
170                    boolean includeMountfolders)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
175                    long groupId, long parentFolderId, int start, int end,
176                    com.liferay.portal.kernel.util.OrderByComparator obc)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException;
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public int getMountFoldersCount(long groupId, long parentFolderId)
182                    throws com.liferay.portal.kernel.exception.SystemException;
183    
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
186                    long groupId, 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 java.util.List<java.lang.Long> getSubfolderIds(long groupId,
192                    long folderId, boolean recurse)
193                    throws com.liferay.portal.kernel.exception.PortalException,
194                            com.liferay.portal.kernel.exception.SystemException;
195    
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public boolean hasFolderLock(long folderId)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException;
200    
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public boolean hasInheritableLock(long folderId)
203                    throws com.liferay.portal.kernel.exception.PortalException,
204                            com.liferay.portal.kernel.exception.SystemException;
205    
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public boolean isFolderLocked(long folderId)
208                    throws com.liferay.portal.kernel.exception.SystemException;
209    
210            public com.liferay.portal.model.Lock lockFolder(long folderId)
211                    throws com.liferay.portal.kernel.exception.PortalException,
212                            com.liferay.portal.kernel.exception.SystemException;
213    
214            public com.liferay.portal.model.Lock lockFolder(long folderId,
215                    java.lang.String owner, boolean inheritable, long expirationTime)
216                    throws com.liferay.portal.kernel.exception.PortalException,
217                            com.liferay.portal.kernel.exception.SystemException;
218    
219            public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
220                    long folderId, long parentFolderId,
221                    com.liferay.portal.service.ServiceContext serviceContext)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            public com.liferay.portal.model.Lock refreshFolderLock(
226                    java.lang.String lockUuid, long companyId, long expirationTime)
227                    throws com.liferay.portal.kernel.exception.PortalException,
228                            com.liferay.portal.kernel.exception.SystemException;
229    
230            public void unlockFolder(long groupId, long parentFolderId,
231                    java.lang.String name, java.lang.String lockUuid)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException;
234    
235            public void unlockFolder(long folderId, java.lang.String lockUuid)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException;
238    
239            public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
240                    long folderId, java.lang.String name, java.lang.String description,
241                    long defaultFileEntryTypeId,
242                    java.util.List<java.lang.Long> fileEntryTypeIds,
243                    boolean overrideFileEntryTypes,
244                    com.liferay.portal.service.ServiceContext serviceContext)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            public boolean verifyInheritableLock(long folderId,
249                    java.lang.String lockUuid)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    }