1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.documentlibrary.service;
24  
25  
26  /**
27   * <a href="DLFileEntryLocalService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryLocalServiceFactory
48   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryLocalServiceUtil
49   *
50   */
51  public interface DLFileEntryLocalService {
52      public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
53          com.liferay.portlet.documentlibrary.model.DLFileEntry model)
54          throws com.liferay.portal.SystemException;
55  
56      public java.util.List dynamicQuery(
57          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
58          throws com.liferay.portal.SystemException;
59  
60      public java.util.List dynamicQuery(
61          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
62          int begin, int end) throws com.liferay.portal.SystemException;
63  
64      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
65          com.liferay.portlet.documentlibrary.model.DLFileEntry model)
66          throws com.liferay.portal.SystemException;
67  
68      public com.liferay.portlet.documentlibrary.service.persistence.DLFileEntryPersistence getDLFileEntryPersistence();
69  
70      public void setDLFileEntryPersistence(
71          com.liferay.portlet.documentlibrary.service.persistence.DLFileEntryPersistence dlFileEntryPersistence);
72  
73      public com.liferay.portlet.documentlibrary.service.persistence.DLFileEntryFinder getDLFileEntryFinder();
74  
75      public void setDLFileEntryFinder(
76          com.liferay.portlet.documentlibrary.service.persistence.DLFileEntryFinder dlFileEntryFinder);
77  
78      public com.liferay.portlet.documentlibrary.service.persistence.DLFileEntryAndShortcutFinder getDLFileEntryAndShortcutFinder();
79  
80      public void setDLFileEntryAndShortcutFinder(
81          com.liferay.portlet.documentlibrary.service.persistence.DLFileEntryAndShortcutFinder dlFileEntryAndShortcutFinder);
82  
83      public com.liferay.portlet.documentlibrary.service.persistence.DLFileRankPersistence getDLFileRankPersistence();
84  
85      public void setDLFileRankPersistence(
86          com.liferay.portlet.documentlibrary.service.persistence.DLFileRankPersistence dlFileRankPersistence);
87  
88      public com.liferay.portlet.documentlibrary.service.persistence.DLFileRankFinder getDLFileRankFinder();
89  
90      public void setDLFileRankFinder(
91          com.liferay.portlet.documentlibrary.service.persistence.DLFileRankFinder dlFileRankFinder);
92  
93      public com.liferay.portlet.documentlibrary.service.persistence.DLFileShortcutPersistence getDLFileShortcutPersistence();
94  
95      public void setDLFileShortcutPersistence(
96          com.liferay.portlet.documentlibrary.service.persistence.DLFileShortcutPersistence dlFileShortcutPersistence);
97  
98      public com.liferay.portlet.documentlibrary.service.persistence.DLFileShortcutFinder getDLFileShortcutFinder();
99  
100     public void setDLFileShortcutFinder(
101         com.liferay.portlet.documentlibrary.service.persistence.DLFileShortcutFinder dlFileShortcutFinder);
102 
103     public com.liferay.portlet.documentlibrary.service.persistence.DLFileVersionPersistence getDLFileVersionPersistence();
104 
105     public void setDLFileVersionPersistence(
106         com.liferay.portlet.documentlibrary.service.persistence.DLFileVersionPersistence dlFileVersionPersistence);
107 
108     public com.liferay.portlet.documentlibrary.service.persistence.DLFolderPersistence getDLFolderPersistence();
109 
110     public void setDLFolderPersistence(
111         com.liferay.portlet.documentlibrary.service.persistence.DLFolderPersistence dlFolderPersistence);
112 
113     public com.liferay.portal.service.persistence.ResourcePersistence getResourcePersistence();
114 
115     public void setResourcePersistence(
116         com.liferay.portal.service.persistence.ResourcePersistence resourcePersistence);
117 
118     public com.liferay.portal.service.persistence.ResourceFinder getResourceFinder();
119 
120     public void setResourceFinder(
121         com.liferay.portal.service.persistence.ResourceFinder resourceFinder);
122 
123     public com.liferay.portal.service.persistence.UserPersistence getUserPersistence();
124 
125     public void setUserPersistence(
126         com.liferay.portal.service.persistence.UserPersistence userPersistence);
127 
128     public com.liferay.portal.service.persistence.UserFinder getUserFinder();
129 
130     public void setUserFinder(
131         com.liferay.portal.service.persistence.UserFinder userFinder);
132 
133     public com.liferay.portal.service.persistence.WebDAVPropsPersistence getWebDAVPropsPersistence();
134 
135     public void setWebDAVPropsPersistence(
136         com.liferay.portal.service.persistence.WebDAVPropsPersistence webDAVPropsPersistence);
137 
138     public com.liferay.portlet.messageboards.service.persistence.MBMessagePersistence getMBMessagePersistence();
139 
140     public void setMBMessagePersistence(
141         com.liferay.portlet.messageboards.service.persistence.MBMessagePersistence mbMessagePersistence);
142 
143     public com.liferay.portlet.messageboards.service.persistence.MBMessageFinder getMBMessageFinder();
144 
145     public void setMBMessageFinder(
146         com.liferay.portlet.messageboards.service.persistence.MBMessageFinder mbMessageFinder);
147 
148     public com.liferay.portlet.ratings.service.persistence.RatingsStatsPersistence getRatingsStatsPersistence();
149 
150     public void setRatingsStatsPersistence(
151         com.liferay.portlet.ratings.service.persistence.RatingsStatsPersistence ratingsStatsPersistence);
152 
153     public com.liferay.portlet.tags.service.persistence.TagsAssetPersistence getTagsAssetPersistence();
154 
155     public void setTagsAssetPersistence(
156         com.liferay.portlet.tags.service.persistence.TagsAssetPersistence tagsAssetPersistence);
157 
158     public com.liferay.portlet.tags.service.persistence.TagsAssetFinder getTagsAssetFinder();
159 
160     public void setTagsAssetFinder(
161         com.liferay.portlet.tags.service.persistence.TagsAssetFinder tagsAssetFinder);
162 
163     public void afterPropertiesSet();
164 
165     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
166         long userId, long folderId, java.lang.String name,
167         java.lang.String title, java.lang.String description,
168         java.lang.String[] tagsEntries, java.lang.String extraSettings,
169         java.io.File file, boolean addCommunityPermissions,
170         boolean addGuestPermissions)
171         throws com.liferay.portal.SystemException, 
172             com.liferay.portal.PortalException;
173 
174     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
175         long userId, long folderId, java.lang.String name,
176         java.lang.String title, java.lang.String description,
177         java.lang.String[] tagsEntries, java.lang.String extraSettings,
178         byte[] byteArray, boolean addCommunityPermissions,
179         boolean addGuestPermissions)
180         throws com.liferay.portal.SystemException, 
181             com.liferay.portal.PortalException;
182 
183     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
184         java.lang.String uuid, long userId, long folderId,
185         java.lang.String name, java.lang.String title,
186         java.lang.String description, java.lang.String[] tagsEntries,
187         java.lang.String extraSettings, byte[] byteArray,
188         boolean addCommunityPermissions, boolean addGuestPermissions)
189         throws com.liferay.portal.SystemException, 
190             com.liferay.portal.PortalException;
191 
192     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
193         long userId, long folderId, java.lang.String name,
194         java.lang.String title, java.lang.String description,
195         java.lang.String[] tagsEntries, java.lang.String extraSettings,
196         java.io.File file, java.lang.String[] communityPermissions,
197         java.lang.String[] guestPermissions)
198         throws com.liferay.portal.SystemException, 
199             com.liferay.portal.PortalException;
200 
201     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
202         long userId, long folderId, java.lang.String name,
203         java.lang.String title, java.lang.String description,
204         java.lang.String[] tagsEntries, java.lang.String extraSettings,
205         byte[] byteArray, java.lang.String[] communityPermissions,
206         java.lang.String[] guestPermissions)
207         throws com.liferay.portal.SystemException, 
208             com.liferay.portal.PortalException;
209 
210     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
211         long userId, long folderId, java.lang.String name,
212         java.lang.String title, java.lang.String description,
213         java.lang.String[] tagsEntries, java.lang.String extraSettings,
214         java.io.File file, java.lang.Boolean addCommunityPermissions,
215         java.lang.Boolean addGuestPermissions,
216         java.lang.String[] communityPermissions,
217         java.lang.String[] guestPermissions)
218         throws com.liferay.portal.SystemException, 
219             com.liferay.portal.PortalException;
220 
221     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
222         java.lang.String uuid, long userId, long folderId,
223         java.lang.String name, java.lang.String title,
224         java.lang.String description, java.lang.String[] tagsEntries,
225         java.lang.String extraSettings, byte[] byteArray,
226         java.lang.Boolean addCommunityPermissions,
227         java.lang.Boolean addGuestPermissions,
228         java.lang.String[] communityPermissions,
229         java.lang.String[] guestPermissions)
230         throws com.liferay.portal.SystemException, 
231             com.liferay.portal.PortalException;
232 
233     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
234         java.lang.String uuid, long userId, long folderId,
235         java.lang.String name, java.lang.String title,
236         java.lang.String description, java.lang.String[] tagsEntries,
237         java.lang.String extraSettings, java.io.InputStream is, long size,
238         java.lang.Boolean addCommunityPermissions,
239         java.lang.Boolean addGuestPermissions,
240         java.lang.String[] communityPermissions,
241         java.lang.String[] guestPermissions)
242         throws com.liferay.portal.SystemException, 
243             com.liferay.portal.PortalException;
244 
245     public void addFileEntryResources(long folderId, java.lang.String name,
246         boolean addCommunityPermissions, boolean addGuestPermissions)
247         throws com.liferay.portal.SystemException, 
248             com.liferay.portal.PortalException;
249 
250     public void addFileEntryResources(
251         com.liferay.portlet.documentlibrary.model.DLFolder folder,
252         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
253         boolean addCommunityPermissions, boolean addGuestPermissions)
254         throws com.liferay.portal.SystemException, 
255             com.liferay.portal.PortalException;
256 
257     public void addFileEntryResources(long folderId, java.lang.String name,
258         java.lang.String[] communityPermissions,
259         java.lang.String[] guestPermissions)
260         throws com.liferay.portal.SystemException, 
261             com.liferay.portal.PortalException;
262 
263     public void addFileEntryResources(
264         com.liferay.portlet.documentlibrary.model.DLFolder folder,
265         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
266         java.lang.String[] communityPermissions,
267         java.lang.String[] guestPermissions)
268         throws com.liferay.portal.SystemException, 
269             com.liferay.portal.PortalException;
270 
271     public com.liferay.portlet.documentlibrary.model.DLFileEntry addOrOverwriteFileEntry(
272         long userId, long folderId, java.lang.String name,
273         java.lang.String sourceName, java.lang.String title,
274         java.lang.String description, java.lang.String[] tagsEntries,
275         java.lang.String extraSettings, java.io.File file,
276         boolean addCommunityPermissions, boolean addGuestPermissions)
277         throws com.liferay.portal.SystemException, 
278             com.liferay.portal.PortalException;
279 
280     public void deleteFileEntries(long folderId)
281         throws com.liferay.portal.SystemException, 
282             com.liferay.portal.PortalException;
283 
284     public void deleteFileEntry(long folderId, java.lang.String name)
285         throws com.liferay.portal.SystemException, 
286             com.liferay.portal.PortalException;
287 
288     public void deleteFileEntry(long folderId, java.lang.String name,
289         double version)
290         throws com.liferay.portal.SystemException, 
291             com.liferay.portal.PortalException;
292 
293     public void deleteFileEntry(
294         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
295         throws com.liferay.portal.SystemException, 
296             com.liferay.portal.PortalException;
297 
298     public java.util.List getCompanyFileEntries(long companyId, int begin,
299         int end) throws com.liferay.portal.SystemException;
300 
301     public java.util.List getCompanyFileEntries(long companyId, int begin,
302         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
303         throws com.liferay.portal.SystemException;
304 
305     public int getCompanyFileEntriesCount(long companyId)
306         throws com.liferay.portal.SystemException;
307 
308     public java.io.InputStream getFileAsStream(long companyId, long userId,
309         long folderId, java.lang.String name)
310         throws com.liferay.portal.SystemException, 
311             com.liferay.portal.PortalException;
312 
313     public java.io.InputStream getFileAsStream(long companyId, long userId,
314         long folderId, java.lang.String name, double version)
315         throws com.liferay.portal.SystemException, 
316             com.liferay.portal.PortalException;
317 
318     public java.util.List getFileEntries(long folderId)
319         throws com.liferay.portal.SystemException;
320 
321     public java.util.List getFileEntries(long folderId, int begin, int end)
322         throws com.liferay.portal.SystemException;
323 
324     public java.util.List getFileEntries(long folderId, int begin, int end,
325         com.liferay.portal.kernel.util.OrderByComparator obc)
326         throws com.liferay.portal.SystemException;
327 
328     public java.util.List getFileEntriesAndShortcuts(long folderId, int begin,
329         int end) throws com.liferay.portal.SystemException;
330 
331     public java.util.List getFileEntriesAndShortcuts(java.util.List folderIds,
332         int begin, int end) throws com.liferay.portal.SystemException;
333 
334     public int getFileEntriesAndShortcutsCount(long folderId)
335         throws com.liferay.portal.SystemException;
336 
337     public int getFileEntriesAndShortcutsCount(java.util.List folderIds)
338         throws com.liferay.portal.SystemException;
339 
340     public int getFileEntriesCount(long folderId)
341         throws com.liferay.portal.SystemException;
342 
343     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
344         long fileEntryId)
345         throws com.liferay.portal.SystemException, 
346             com.liferay.portal.PortalException;
347 
348     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
349         long folderId, java.lang.String name)
350         throws com.liferay.portal.SystemException, 
351             com.liferay.portal.PortalException;
352 
353     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
354         java.lang.String uuid, long groupId)
355         throws com.liferay.portal.SystemException, 
356             com.liferay.portal.PortalException;
357 
358     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
359         long folderId, java.lang.String titleWithExtension)
360         throws com.liferay.portal.SystemException, 
361             com.liferay.portal.PortalException;
362 
363     public int getFoldersFileEntriesCount(java.util.List folderIds)
364         throws com.liferay.portal.SystemException;
365 
366     public java.util.List getGroupFileEntries(long groupId, int begin, int end)
367         throws com.liferay.portal.SystemException;
368 
369     public java.util.List getGroupFileEntries(long groupId, int begin, int end,
370         com.liferay.portal.kernel.util.OrderByComparator obc)
371         throws com.liferay.portal.SystemException;
372 
373     public java.util.List getGroupFileEntries(long groupId, long userId,
374         int begin, int end) throws com.liferay.portal.SystemException;
375 
376     public java.util.List getGroupFileEntries(long groupId, long userId,
377         int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
378         throws com.liferay.portal.SystemException;
379 
380     public int getGroupFileEntriesCount(long groupId)
381         throws com.liferay.portal.SystemException;
382 
383     public int getGroupFileEntriesCount(long groupId, long userId)
384         throws com.liferay.portal.SystemException;
385 
386     public java.util.List getNoAssetFileEntries()
387         throws com.liferay.portal.SystemException;
388 
389     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
390         long userId, long folderId, long newFolderId, java.lang.String name,
391         java.lang.String sourceFileName, java.lang.String title,
392         java.lang.String description, java.lang.String[] tagsEntries,
393         java.lang.String extraSettings, java.io.File file)
394         throws com.liferay.portal.SystemException, 
395             com.liferay.portal.PortalException;
396 
397     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
398         long userId, long folderId, long newFolderId, java.lang.String name,
399         java.lang.String sourceFileName, java.lang.String title,
400         java.lang.String description, java.lang.String[] tagsEntries,
401         java.lang.String extraSettings, byte[] byteArray)
402         throws com.liferay.portal.SystemException, 
403             com.liferay.portal.PortalException;
404 
405     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
406         long userId, long folderId, long newFolderId, java.lang.String name,
407         java.lang.String sourceFileName, java.lang.String title,
408         java.lang.String description, java.lang.String[] tagsEntries,
409         java.lang.String extraSettings, java.io.InputStream is, long size)
410         throws com.liferay.portal.SystemException, 
411             com.liferay.portal.PortalException;
412 
413     public void updateTagsAsset(long userId,
414         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
415         java.lang.String[] tagsEntries)
416         throws com.liferay.portal.SystemException, 
417             com.liferay.portal.PortalException;
418 }