001    /**
002     * Copyright (c) 2000-present 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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.security.ac.AccessControlled;
026    import com.liferay.portal.service.BaseService;
027    
028    /**
029     * Provides the remote service interface for DLFileEntry. Methods of this
030     * service are expected to have security checks based on the propagated JAAS
031     * credentials because this service can be accessed remotely.
032     *
033     * @author Brian Wing Shun Chan
034     * @see DLFileEntryServiceUtil
035     * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl
036     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl
037     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @ProviderType
042    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
043            PortalException.class, SystemException.class})
044    public interface DLFileEntryService extends BaseService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link DLFileEntryServiceUtil} to access the document library file entry remote service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050            public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
051                    long groupId, long repositoryId, long folderId,
052                    java.lang.String sourceFileName, java.lang.String mimeType,
053                    java.lang.String title, java.lang.String description,
054                    java.lang.String changeLog, long fileEntryTypeId,
055                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
056                    java.io.File file, java.io.InputStream is, long size,
057                    com.liferay.portal.service.ServiceContext serviceContext)
058                    throws com.liferay.portal.kernel.exception.PortalException;
059    
060            public com.liferay.portlet.documentlibrary.model.DLFileVersion cancelCheckOut(
061                    long fileEntryId)
062                    throws com.liferay.portal.kernel.exception.PortalException;
063    
064            /**
065            * @deprecated As of 6.2.0, replaced by {@link #checkInFileEntry(long,
066            String, ServiceContext)}
067            */
068            @java.lang.Deprecated
069            public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid)
070                    throws com.liferay.portal.kernel.exception.PortalException;
071    
072            public void checkInFileEntry(long fileEntryId, java.lang.String lockUuid,
073                    com.liferay.portal.service.ServiceContext serviceContext)
074                    throws com.liferay.portal.kernel.exception.PortalException;
075    
076            public void checkInFileEntry(long fileEntryId, boolean major,
077                    java.lang.String changeLog,
078                    com.liferay.portal.service.ServiceContext serviceContext)
079                    throws com.liferay.portal.kernel.exception.PortalException;
080    
081            /**
082            * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long,
083            ServiceContext)}
084            */
085            @java.lang.Deprecated
086            public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
087                    long fileEntryId)
088                    throws com.liferay.portal.kernel.exception.PortalException;
089    
090            /**
091            * @deprecated As of 6.2.0, replaced by {@link #checkOutFileEntry(long,
092            String, long, ServiceContext)}
093            */
094            @java.lang.Deprecated
095            public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
096                    long fileEntryId, java.lang.String owner, long expirationTime)
097                    throws com.liferay.portal.kernel.exception.PortalException;
098    
099            public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
100                    long fileEntryId, java.lang.String owner, long expirationTime,
101                    com.liferay.portal.service.ServiceContext serviceContext)
102                    throws com.liferay.portal.kernel.exception.PortalException;
103    
104            public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
105                    long fileEntryId,
106                    com.liferay.portal.service.ServiceContext serviceContext)
107                    throws com.liferay.portal.kernel.exception.PortalException;
108    
109            public com.liferay.portlet.documentlibrary.model.DLFileEntry copyFileEntry(
110                    long groupId, long repositoryId, long fileEntryId, long destFolderId,
111                    com.liferay.portal.service.ServiceContext serviceContext)
112                    throws com.liferay.portal.kernel.exception.PortalException;
113    
114            public void deleteFileEntry(long fileEntryId)
115                    throws com.liferay.portal.kernel.exception.PortalException;
116    
117            public void deleteFileEntry(long groupId, long folderId,
118                    java.lang.String title)
119                    throws com.liferay.portal.kernel.exception.PortalException;
120    
121            public void deleteFileVersion(long fileEntryId, java.lang.String version)
122                    throws com.liferay.portal.kernel.exception.PortalException;
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByImageId(
126                    long imageId)
127                    throws com.liferay.portal.kernel.exception.PortalException;
128    
129            /**
130            * Returns the Spring bean ID for this bean.
131            *
132            * @return the Spring bean ID for this bean
133            */
134            public java.lang.String getBeanIdentifier();
135    
136            public java.io.InputStream getFileAsStream(long fileEntryId,
137                    java.lang.String version)
138                    throws com.liferay.portal.kernel.exception.PortalException;
139    
140            public java.io.InputStream getFileAsStream(long fileEntryId,
141                    java.lang.String version, boolean incrementCounter)
142                    throws com.liferay.portal.kernel.exception.PortalException;
143    
144            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
146                    long groupId, long folderId, long fileEntryTypeId, int start, int end,
147                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
148                    throws com.liferay.portal.kernel.exception.PortalException;
149    
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
152                    long groupId, long folderId, java.lang.String[] mimeTypes, int start,
153                    int end,
154                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
155                    throws com.liferay.portal.kernel.exception.PortalException;
156    
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
159                    long groupId, long folderId, int start, int end,
160                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
161                    throws com.liferay.portal.kernel.exception.PortalException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
165                    long groupId, long folderId, int status, int start, int end,
166                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
167                    throws com.liferay.portal.kernel.exception.PortalException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public int getFileEntriesCount(long groupId, long folderId);
171    
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public int getFileEntriesCount(long groupId, long folderId,
174                    long fileEntryTypeId);
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public int getFileEntriesCount(long groupId, long folderId,
178                    java.lang.String[] mimeTypes);
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public int getFileEntriesCount(long groupId, long folderId, int status);
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
185                    long fileEntryId)
186                    throws com.liferay.portal.kernel.exception.PortalException;
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
190                    long groupId, long folderId, java.lang.String title)
191                    throws com.liferay.portal.kernel.exception.PortalException;
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
195                    java.lang.String uuid, long groupId)
196                    throws com.liferay.portal.kernel.exception.PortalException;
197    
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public com.liferay.portal.model.Lock getFileEntryLock(long fileEntryId);
200    
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public int getFoldersFileEntriesCount(long groupId,
203                    java.util.List<java.lang.Long> folderIds, int status);
204    
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
207                    long groupId, long userId, long repositoryId, long rootFolderId,
208                    java.lang.String[] mimeTypes, int status, int start, int end,
209                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
210                    throws com.liferay.portal.kernel.exception.PortalException;
211    
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
214                    long groupId, long userId, long rootFolderId,
215                    java.lang.String[] mimeTypes, int status, int start, int end,
216                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
217                    throws com.liferay.portal.kernel.exception.PortalException;
218    
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
221                    long groupId, long userId, long rootFolderId, int start, int end,
222                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileEntry> obc)
223                    throws com.liferay.portal.kernel.exception.PortalException;
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public int getGroupFileEntriesCount(long groupId, long userId,
227                    long repositoryId, long rootFolderId, java.lang.String[] mimeTypes,
228                    int status) throws com.liferay.portal.kernel.exception.PortalException;
229    
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public int getGroupFileEntriesCount(long groupId, long userId,
232                    long rootFolderId)
233                    throws com.liferay.portal.kernel.exception.PortalException;
234    
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public int getGroupFileEntriesCount(long groupId, long userId,
237                    long rootFolderId, java.lang.String[] mimeTypes, int status)
238                    throws com.liferay.portal.kernel.exception.PortalException;
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public boolean hasFileEntryLock(long fileEntryId)
242                    throws com.liferay.portal.kernel.exception.PortalException;
243    
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public boolean isFileEntryCheckedOut(long fileEntryId)
246                    throws com.liferay.portal.kernel.exception.PortalException;
247    
248            public com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(
249                    long fileEntryId, long newFolderId,
250                    com.liferay.portal.service.ServiceContext serviceContext)
251                    throws com.liferay.portal.kernel.exception.PortalException;
252    
253            public com.liferay.portal.model.Lock refreshFileEntryLock(
254                    java.lang.String lockUuid, long companyId, long expirationTime)
255                    throws com.liferay.portal.kernel.exception.PortalException;
256    
257            public void revertFileEntry(long fileEntryId, java.lang.String version,
258                    com.liferay.portal.service.ServiceContext serviceContext)
259                    throws com.liferay.portal.kernel.exception.PortalException;
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public com.liferay.portal.kernel.search.Hits search(long groupId,
263                    long creatorUserId, long folderId, java.lang.String[] mimeTypes,
264                    int status, int start, int end)
265                    throws com.liferay.portal.kernel.exception.PortalException;
266    
267            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
268            public com.liferay.portal.kernel.search.Hits search(long groupId,
269                    long creatorUserId, int status, int start, int end)
270                    throws com.liferay.portal.kernel.exception.PortalException;
271    
272            /**
273            * Sets the Spring bean ID for this bean.
274            *
275            * @param beanIdentifier the Spring bean ID for this bean
276            */
277            public void setBeanIdentifier(java.lang.String beanIdentifier);
278    
279            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
280                    long fileEntryId, java.lang.String sourceFileName,
281                    java.lang.String mimeType, java.lang.String title,
282                    java.lang.String description, java.lang.String changeLog,
283                    boolean majorVersion, long fileEntryTypeId,
284                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
285                    java.io.File file, java.io.InputStream is, long size,
286                    com.liferay.portal.service.ServiceContext serviceContext)
287                    throws com.liferay.portal.kernel.exception.PortalException;
288    
289            public boolean verifyFileEntryCheckOut(long fileEntryId,
290                    java.lang.String lockUuid)
291                    throws com.liferay.portal.kernel.exception.PortalException;
292    
293            public boolean verifyFileEntryLock(long fileEntryId,
294                    java.lang.String lockUuid)
295                    throws com.liferay.portal.kernel.exception.PortalException;
296    }