001    /**
002     * Copyright (c) 2000-2011 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.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.PersistedModelLocalService;
023    
024    /**
025     * The interface for the document library file entry local service.
026     *
027     * <p>
028     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see DLFileEntryLocalServiceUtil
033     * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryLocalServiceBaseImpl
034     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface DLFileEntryLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link DLFileEntryLocalServiceUtil} to access the document library file entry local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the document library file entry to the database. Also notifies the appropriate model listeners.
048            *
049            * @param dlFileEntry the document library file entry
050            * @return the document library file entry that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
054                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new document library file entry with the primary key. Does not add the document library file entry to the database.
059            *
060            * @param fileEntryId the primary key for the new document library file entry
061            * @return the new document library file entry
062            */
063            public com.liferay.portlet.documentlibrary.model.DLFileEntry createDLFileEntry(
064                    long fileEntryId);
065    
066            /**
067            * Deletes the document library file entry with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param fileEntryId the primary key of the document library file entry
070            * @throws PortalException if a document library file entry with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteDLFileEntry(long fileEntryId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the document library file entry from the database. Also notifies the appropriate model listeners.
079            *
080            * @param dlFileEntry the document library file entry
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteDLFileEntry(
084                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the document library file entry with the primary key.
151            *
152            * @param fileEntryId the primary key of the document library file entry
153            * @return the document library file entry
154            * @throws PortalException if a document library file entry with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntry(
159                    long fileEntryId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns the document library file entry with the UUID in the group.
171            *
172            * @param uuid the UUID of document library file entry
173            * @param groupId the group id of the document library file entry
174            * @return the document library file entry
175            * @throws PortalException if a document library file entry with the UUID in the group could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntryByUuidAndGroupId(
180                    java.lang.String uuid, long groupId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns a range of all the document library file entries.
186            *
187            * <p>
188            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
189            * </p>
190            *
191            * @param start the lower bound of the range of document library file entries
192            * @param end the upper bound of the range of document library file entries (not inclusive)
193            * @return the range of document library file entries
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDLFileEntries(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of document library file entries.
203            *
204            * @return the number of document library file entries
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getDLFileEntriesCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the document library file entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param dlFileEntry the document library file entry
215            * @return the document library file entry that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
219                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the document library file entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param dlFileEntry the document library file entry
226            * @param merge whether to merge the document library file entry with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
227            * @return the document library file entry that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
231                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
232                    boolean merge)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
250                    long userId, long groupId, long repositoryId, long folderId,
251                    java.lang.String sourceFileName, java.lang.String mimeType,
252                    java.lang.String title, java.lang.String description,
253                    java.lang.String changeLog, long fileEntryTypeId,
254                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
255                    java.io.File file, java.io.InputStream is, long size,
256                    com.liferay.portal.service.ServiceContext serviceContext)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void addFileEntryResources(
261                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
262                    boolean addGroupPermissions, boolean addGuestPermissions)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void addFileEntryResources(
267                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
268                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public void cancelCheckOut(long userId, long fileEntryId)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public void checkInFileEntry(long userId, long fileEntryId,
277                    boolean majorVersion, java.lang.String changeLog,
278                    com.liferay.portal.service.ServiceContext serviceContext)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            public void checkInFileEntry(long userId, long fileEntryId,
283                    java.lang.String lockUuid)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException;
286    
287            public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
288                    long userId, long fileEntryId)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public com.liferay.portlet.documentlibrary.model.DLFileEntry checkOutFileEntry(
293                    long userId, long fileEntryId, java.lang.String owner,
294                    long expirationTime)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public void convertExtraSettings(java.lang.String[] keys)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            public void copyFileEntryMetadata(long companyId, long fileEntryTypeId,
303                    long fileEntryId, long fromFileVersionId, long toFileVersionId,
304                    com.liferay.portal.service.ServiceContext serviceContext)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException;
307    
308            public void deleteFileEntries(long groupId, long folderId)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public void deleteFileEntry(long fileEntryId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            public void deleteFileEntry(long userId, long fileEntryId)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public com.liferay.portlet.documentlibrary.model.DLFileEntry fetchFileEntryByAnyImageId(
322                    long imageId)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getExtraSettingsFileEntries(
327                    int start, int end)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.io.File getFile(long userId, long fileEntryId,
332                    java.lang.String version, boolean incrementCounter)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException;
335    
336            public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
337                    java.lang.String version)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException;
340    
341            public java.io.InputStream getFileAsStream(long userId, long fileEntryId,
342                    java.lang.String version, boolean incrementCounter)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
348                    int start, int end)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
353                    long groupId, long folderId, int start, int end,
354                    com.liferay.portal.kernel.util.OrderByComparator obc)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public int getFileEntriesCount()
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public int getFileEntriesCount(long groupId, long folderId)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
367                    long fileEntryId)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException;
370    
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
373                    long groupId, long folderId, java.lang.String title)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException;
376    
377            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
378            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByName(
379                    long groupId, long folderId, java.lang.String name)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException;
382    
383            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
384            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
385                    java.lang.String uuid, long groupId)
386                    throws com.liferay.portal.kernel.exception.PortalException,
387                            com.liferay.portal.kernel.exception.SystemException;
388    
389            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
390            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
391                    long groupId, int start, int end)
392                    throws com.liferay.portal.kernel.exception.SystemException;
393    
394            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
395            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
396                    long groupId, int start, int end,
397                    com.liferay.portal.kernel.util.OrderByComparator obc)
398                    throws com.liferay.portal.kernel.exception.SystemException;
399    
400            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
402                    long groupId, long userId, int start, int end)
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
406            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
407                    long groupId, long userId, int start, int end,
408                    com.liferay.portal.kernel.util.OrderByComparator obc)
409                    throws com.liferay.portal.kernel.exception.SystemException;
410    
411            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
412            public int getGroupFileEntriesCount(long groupId)
413                    throws com.liferay.portal.kernel.exception.SystemException;
414    
415            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
416            public int getGroupFileEntriesCount(long groupId, long userId)
417                    throws com.liferay.portal.kernel.exception.SystemException;
418    
419            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
420            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
421                    throws com.liferay.portal.kernel.exception.SystemException;
422    
423            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
424            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getOrphanedFileEntries()
425                    throws com.liferay.portal.kernel.exception.SystemException;
426    
427            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
428            public boolean hasExtraSettings()
429                    throws com.liferay.portal.kernel.exception.SystemException;
430    
431            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
432            public boolean hasFileEntryLock(long userId, long fileEntryId)
433                    throws com.liferay.portal.kernel.exception.PortalException,
434                            com.liferay.portal.kernel.exception.SystemException;
435    
436            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
437            public boolean isFileEntryCheckedOut(long fileEntryId)
438                    throws com.liferay.portal.kernel.exception.PortalException,
439                            com.liferay.portal.kernel.exception.SystemException;
440    
441            public com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(
442                    long userId, long fileEntryId, long newFolderId,
443                    com.liferay.portal.service.ServiceContext serviceContext)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException;
446    
447            public void revertFileEntry(long userId, long fileEntryId,
448                    java.lang.String version,
449                    com.liferay.portal.service.ServiceContext serviceContext)
450                    throws com.liferay.portal.kernel.exception.PortalException,
451                            com.liferay.portal.kernel.exception.SystemException;
452    
453            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
454                    long userId, long fileEntryId, java.lang.String sourceFileName,
455                    java.lang.String mimeType, java.lang.String title,
456                    java.lang.String description, java.lang.String changeLog,
457                    boolean majorVersion, long fileEntryTypeId,
458                    java.util.Map<java.lang.String, com.liferay.portlet.dynamicdatamapping.storage.Fields> fieldsMap,
459                    java.io.File file, java.io.InputStream is, long size,
460                    com.liferay.portal.service.ServiceContext serviceContext)
461                    throws com.liferay.portal.kernel.exception.PortalException,
462                            com.liferay.portal.kernel.exception.SystemException;
463    
464            public void updateSmallImage(long smallImageId, long largeImageId)
465                    throws com.liferay.portal.kernel.exception.PortalException,
466                            com.liferay.portal.kernel.exception.SystemException;
467    
468            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateStatus(
469                    long userId, long fileVersionId, int status,
470                    java.util.Map<java.lang.String, java.io.Serializable> workflowContext,
471                    com.liferay.portal.service.ServiceContext serviceContext)
472                    throws com.liferay.portal.kernel.exception.PortalException,
473                            com.liferay.portal.kernel.exception.SystemException;
474    
475            public boolean verifyFileEntryCheckOut(long fileEntryId,
476                    java.lang.String lockUuid)
477                    throws com.liferay.portal.kernel.exception.PortalException,
478                            com.liferay.portal.kernel.exception.SystemException;
479    }