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 file entry local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link DLFileEntryLocalServiceUtil} to access the d l 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see DLFileEntryLocalServiceUtil
036     * @see com.liferay.portlet.documentlibrary.service.base.DLFileEntryLocalServiceBaseImpl
037     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface DLFileEntryLocalService {
043            /**
044            * Adds the d l file entry to the database. Also notifies the appropriate model listeners.
045            *
046            * @param dlFileEntry the d l file entry to add
047            * @return the d l file entry that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
051                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new d l file entry with the primary key. Does not add the d l file entry to the database.
056            *
057            * @param fileEntryId the primary key for the new d l file entry
058            * @return the new d l file entry
059            */
060            public com.liferay.portlet.documentlibrary.model.DLFileEntry createDLFileEntry(
061                    long fileEntryId);
062    
063            /**
064            * Deletes the d l file entry with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param fileEntryId the primary key of the d l file entry to delete
067            * @throws PortalException if a d l file entry with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteDLFileEntry(long fileEntryId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the d l file entry from the database. Also notifies the appropriate model listeners.
076            *
077            * @param dlFileEntry the d l file entry to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteDLFileEntry(
081                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the d l file entry with the primary key.
148            *
149            * @param fileEntryId the primary key of the d l file entry to get
150            * @return the d l file entry
151            * @throws PortalException if a d l file entry with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntry(
156                    long fileEntryId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets the d l file entry with the UUID and group id.
162            *
163            * @param uuid the UUID of d l file entry to get
164            * @param groupId the group id of the d l file entry to get
165            * @return the d l file entry
166            * @throws PortalException if a d l file entry with the UUID and group id could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntryByUuidAndGroupId(
171                    java.lang.String uuid, long groupId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Gets a range of all the d l file entries.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of d l file entries to return
183            * @param end the upper bound of the range of d l file entries to return (not inclusive)
184            * @return the range of d l file entries
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDLFileEntries(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Gets the number of d l file entries.
194            *
195            * @return the number of d l file entries
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getDLFileEntriesCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the d l file entry in the database. Also notifies the appropriate model listeners.
204            *
205            * @param dlFileEntry the d l file entry to update
206            * @return the d l file entry that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
210                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the d l file entry in the database. Also notifies the appropriate model listeners.
215            *
216            * @param dlFileEntry the d l file entry to update
217            * @param merge whether to merge the d l 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.
218            * @return the d l file entry that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
222                    com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
227                    long userId, long groupId, long folderId, java.lang.String name,
228                    java.lang.String title, java.lang.String description,
229                    java.lang.String changeLog, java.lang.String extraSettings,
230                    byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
235                    long userId, long groupId, long folderId, java.lang.String name,
236                    java.lang.String title, java.lang.String description,
237                    java.lang.String changeLog, java.lang.String extraSettings,
238                    java.io.File file,
239                    com.liferay.portal.service.ServiceContext serviceContext)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException;
242    
243            public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
244                    long userId, long groupId, long folderId, java.lang.String name,
245                    java.lang.String title, java.lang.String description,
246                    java.lang.String changeLog, java.lang.String extraSettings,
247                    java.io.InputStream is, long size,
248                    com.liferay.portal.service.ServiceContext serviceContext)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            public void addFileEntryResources(
253                    com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
254                    boolean addCommunityPermissions, boolean addGuestPermissions)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            public void addFileEntryResources(
259                    com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
260                    java.lang.String[] communityPermissions,
261                    java.lang.String[] guestPermissions)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void addFileEntryResources(long fileEntryId,
266                    boolean addCommunityPermissions, boolean addGuestPermissions)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void addFileEntryResources(long fileEntryId,
271                    java.lang.String[] communityPermissions,
272                    java.lang.String[] guestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public com.liferay.portlet.documentlibrary.model.DLFileEntry addOrOverwriteFileEntry(
277                    long userId, long groupId, long folderId, java.lang.String name,
278                    java.lang.String sourceName, java.lang.String title,
279                    java.lang.String description, java.lang.String changeLog,
280                    java.lang.String extraSettings, java.io.File file,
281                    com.liferay.portal.service.ServiceContext serviceContext)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            public void deleteFileEntries(long groupId, long folderId)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void deleteFileEntry(
290                    com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            public void deleteFileEntry(long groupId, long folderId,
295                    java.lang.String name)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            public void deleteFileEntry(long groupId, long folderId,
300                    java.lang.String name, java.lang.String version)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
306                    long companyId, int start, int end)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
311                    long companyId, int start, int end,
312                    com.liferay.portal.kernel.util.OrderByComparator obc)
313                    throws com.liferay.portal.kernel.exception.SystemException;
314    
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public int getCompanyFileEntriesCount(long companyId)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            public java.io.InputStream getFileAsStream(long companyId, long userId,
320                    long groupId, long folderId, java.lang.String name)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException;
323    
324            public java.io.InputStream getFileAsStream(long companyId, long userId,
325                    long groupId, long folderId, java.lang.String name,
326                    java.lang.String version)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
332                    long groupId, long folderId)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
337                    long groupId, long folderId, int start, int end)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
342                    long groupId, long folderId, int start, int end,
343                    com.liferay.portal.kernel.util.OrderByComparator obc)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public int getFileEntriesCount(long groupId, long folderId)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
352                    long fileEntryId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
358                    long groupId, long folderId, java.lang.String name)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException;
361    
362            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
363            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
364                    long groupId, long folderId, java.lang.String title)
365                    throws com.liferay.portal.kernel.exception.PortalException,
366                            com.liferay.portal.kernel.exception.SystemException;
367    
368            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
369            public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
370                    java.lang.String uuid, long groupId)
371                    throws com.liferay.portal.kernel.exception.PortalException,
372                            com.liferay.portal.kernel.exception.SystemException;
373    
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public int getFoldersFileEntriesCount(long groupId,
376                    java.util.List<java.lang.Long> folderIds, int status)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
380            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
381                    long groupId, int start, int end)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
386                    long groupId, int start, int end,
387                    com.liferay.portal.kernel.util.OrderByComparator obc)
388                    throws com.liferay.portal.kernel.exception.SystemException;
389    
390            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
391            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
392                    long groupId, long userId, int start, int end)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
396            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
397                    long groupId, long userId, int start, int end,
398                    com.liferay.portal.kernel.util.OrderByComparator obc)
399                    throws com.liferay.portal.kernel.exception.SystemException;
400    
401            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
402            public int getGroupFileEntriesCount(long groupId)
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
406            public int getGroupFileEntriesCount(long groupId, long userId)
407                    throws com.liferay.portal.kernel.exception.SystemException;
408    
409            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
410            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
411                    throws com.liferay.portal.kernel.exception.SystemException;
412    
413            public com.liferay.portlet.documentlibrary.model.DLFileEntry moveFileEntry(
414                    long userId, long groupId, long folderId, long newFolderId,
415                    java.lang.String name,
416                    com.liferay.portal.service.ServiceContext serviceContext)
417                    throws com.liferay.portal.kernel.exception.PortalException,
418                            com.liferay.portal.kernel.exception.SystemException;
419    
420            public void updateAsset(long userId,
421                    com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
422                    com.liferay.portlet.documentlibrary.model.DLFileVersion fileVersion,
423                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
424                    throws com.liferay.portal.kernel.exception.PortalException,
425                            com.liferay.portal.kernel.exception.SystemException;
426    
427            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
428                    long userId, long groupId, long folderId, java.lang.String name,
429                    java.lang.String sourceFileName, java.lang.String title,
430                    java.lang.String description, java.lang.String changeLog,
431                    boolean majorVersion, java.lang.String extraSettings, byte[] bytes,
432                    com.liferay.portal.service.ServiceContext serviceContext)
433                    throws com.liferay.portal.kernel.exception.PortalException,
434                            com.liferay.portal.kernel.exception.SystemException;
435    
436            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
437                    long userId, long groupId, long folderId, java.lang.String name,
438                    java.lang.String sourceFileName, java.lang.String title,
439                    java.lang.String description, java.lang.String changeLog,
440                    boolean majorVersion, java.lang.String extraSettings,
441                    java.io.File file,
442                    com.liferay.portal.service.ServiceContext serviceContext)
443                    throws com.liferay.portal.kernel.exception.PortalException,
444                            com.liferay.portal.kernel.exception.SystemException;
445    
446            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
447                    long userId, long groupId, long folderId, java.lang.String name,
448                    java.lang.String sourceFileName, java.lang.String title,
449                    java.lang.String description, java.lang.String changeLog,
450                    boolean majorVersion, java.lang.String extraSettings,
451                    java.io.InputStream is, long size,
452                    com.liferay.portal.service.ServiceContext serviceContext)
453                    throws com.liferay.portal.kernel.exception.PortalException,
454                            com.liferay.portal.kernel.exception.SystemException;
455    
456            public com.liferay.portlet.documentlibrary.model.DLFileEntry updateStatus(
457                    long userId, long fileEntryId, int status,
458                    com.liferay.portal.service.ServiceContext serviceContext)
459                    throws com.liferay.portal.kernel.exception.PortalException,
460                            com.liferay.portal.kernel.exception.SystemException;
461    }