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 dlFileEntry)
54          throws com.liferay.portal.SystemException;
55  
56      public void deleteDLFileEntry(long fileEntryId)
57          throws com.liferay.portal.SystemException,
58              com.liferay.portal.PortalException;
59  
60      public void deleteDLFileEntry(
61          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
62          throws com.liferay.portal.SystemException,
63              com.liferay.portal.PortalException;
64  
65      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> dynamicQuery(
66          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
67          throws com.liferay.portal.SystemException;
68  
69      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> dynamicQuery(
70          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
71          int begin, int end) throws com.liferay.portal.SystemException;
72  
73      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
74          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
75          throws com.liferay.portal.SystemException;
76  
77      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
78          long userId, long folderId, java.lang.String name,
79          java.lang.String title, java.lang.String description,
80          java.lang.String[] tagsEntries, java.lang.String extraSettings,
81          java.io.File file, boolean addCommunityPermissions,
82          boolean addGuestPermissions)
83          throws com.liferay.portal.SystemException,
84              com.liferay.portal.PortalException;
85  
86      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
87          long userId, long folderId, java.lang.String name,
88          java.lang.String title, java.lang.String description,
89          java.lang.String[] tagsEntries, java.lang.String extraSettings,
90          byte[] byteArray, boolean addCommunityPermissions,
91          boolean addGuestPermissions)
92          throws com.liferay.portal.SystemException,
93              com.liferay.portal.PortalException;
94  
95      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
96          java.lang.String uuid, long userId, long folderId,
97          java.lang.String name, java.lang.String title,
98          java.lang.String description, java.lang.String[] tagsEntries,
99          java.lang.String extraSettings, byte[] byteArray,
100         boolean addCommunityPermissions, boolean addGuestPermissions)
101         throws com.liferay.portal.SystemException,
102             com.liferay.portal.PortalException;
103 
104     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
105         long userId, long folderId, java.lang.String name,
106         java.lang.String title, java.lang.String description,
107         java.lang.String[] tagsEntries, java.lang.String extraSettings,
108         java.io.File file, java.lang.String[] communityPermissions,
109         java.lang.String[] guestPermissions)
110         throws com.liferay.portal.SystemException,
111             com.liferay.portal.PortalException;
112 
113     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
114         long userId, long folderId, java.lang.String name,
115         java.lang.String title, java.lang.String description,
116         java.lang.String[] tagsEntries, java.lang.String extraSettings,
117         byte[] byteArray, java.lang.String[] communityPermissions,
118         java.lang.String[] guestPermissions)
119         throws com.liferay.portal.SystemException,
120             com.liferay.portal.PortalException;
121 
122     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
123         long userId, long folderId, java.lang.String name,
124         java.lang.String title, java.lang.String description,
125         java.lang.String[] tagsEntries, java.lang.String extraSettings,
126         java.io.File file, java.lang.Boolean addCommunityPermissions,
127         java.lang.Boolean addGuestPermissions,
128         java.lang.String[] communityPermissions,
129         java.lang.String[] guestPermissions)
130         throws com.liferay.portal.SystemException,
131             com.liferay.portal.PortalException;
132 
133     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
134         java.lang.String uuid, long userId, long folderId,
135         java.lang.String name, java.lang.String title,
136         java.lang.String description, java.lang.String[] tagsEntries,
137         java.lang.String extraSettings, byte[] byteArray,
138         java.lang.Boolean addCommunityPermissions,
139         java.lang.Boolean addGuestPermissions,
140         java.lang.String[] communityPermissions,
141         java.lang.String[] guestPermissions)
142         throws com.liferay.portal.SystemException,
143             com.liferay.portal.PortalException;
144 
145     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
146         java.lang.String uuid, long userId, long folderId,
147         java.lang.String name, java.lang.String title,
148         java.lang.String description, java.lang.String[] tagsEntries,
149         java.lang.String extraSettings, java.io.InputStream is, long size,
150         java.lang.Boolean addCommunityPermissions,
151         java.lang.Boolean addGuestPermissions,
152         java.lang.String[] communityPermissions,
153         java.lang.String[] guestPermissions)
154         throws com.liferay.portal.SystemException,
155             com.liferay.portal.PortalException;
156 
157     public void addFileEntryResources(long folderId, java.lang.String name,
158         boolean addCommunityPermissions, boolean addGuestPermissions)
159         throws com.liferay.portal.SystemException,
160             com.liferay.portal.PortalException;
161 
162     public void addFileEntryResources(
163         com.liferay.portlet.documentlibrary.model.DLFolder folder,
164         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
165         boolean addCommunityPermissions, boolean addGuestPermissions)
166         throws com.liferay.portal.SystemException,
167             com.liferay.portal.PortalException;
168 
169     public void addFileEntryResources(long folderId, java.lang.String name,
170         java.lang.String[] communityPermissions,
171         java.lang.String[] guestPermissions)
172         throws com.liferay.portal.SystemException,
173             com.liferay.portal.PortalException;
174 
175     public void addFileEntryResources(
176         com.liferay.portlet.documentlibrary.model.DLFolder folder,
177         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
178         java.lang.String[] communityPermissions,
179         java.lang.String[] guestPermissions)
180         throws com.liferay.portal.SystemException,
181             com.liferay.portal.PortalException;
182 
183     public com.liferay.portlet.documentlibrary.model.DLFileEntry addOrOverwriteFileEntry(
184         long userId, long folderId, java.lang.String name,
185         java.lang.String sourceName, java.lang.String title,
186         java.lang.String description, java.lang.String[] tagsEntries,
187         java.lang.String extraSettings, java.io.File file,
188         boolean addCommunityPermissions, boolean addGuestPermissions)
189         throws com.liferay.portal.SystemException,
190             com.liferay.portal.PortalException;
191 
192     public void deleteFileEntries(long folderId)
193         throws com.liferay.portal.SystemException,
194             com.liferay.portal.PortalException;
195 
196     public void deleteFileEntry(long folderId, java.lang.String name)
197         throws com.liferay.portal.SystemException,
198             com.liferay.portal.PortalException;
199 
200     public void deleteFileEntry(long folderId, java.lang.String name,
201         double version)
202         throws com.liferay.portal.SystemException,
203             com.liferay.portal.PortalException;
204 
205     public void deleteFileEntry(
206         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
207         throws com.liferay.portal.SystemException,
208             com.liferay.portal.PortalException;
209 
210     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
211         long companyId, int begin, int end)
212         throws com.liferay.portal.SystemException;
213 
214     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
215         long companyId, int begin, int end,
216         com.liferay.portal.kernel.util.OrderByComparator obc)
217         throws com.liferay.portal.SystemException;
218 
219     public int getCompanyFileEntriesCount(long companyId)
220         throws com.liferay.portal.SystemException;
221 
222     public java.io.InputStream getFileAsStream(long companyId, long userId,
223         long folderId, java.lang.String name)
224         throws com.liferay.portal.SystemException,
225             com.liferay.portal.PortalException;
226 
227     public java.io.InputStream getFileAsStream(long companyId, long userId,
228         long folderId, java.lang.String name, double version)
229         throws com.liferay.portal.SystemException,
230             com.liferay.portal.PortalException;
231 
232     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
233         long folderId) throws com.liferay.portal.SystemException;
234 
235     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
236         long folderId, int begin, int end)
237         throws com.liferay.portal.SystemException;
238 
239     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
240         long folderId, int begin, int end,
241         com.liferay.portal.kernel.util.OrderByComparator obc)
242         throws com.liferay.portal.SystemException;
243 
244     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntriesAndShortcuts(
245         long folderId, int begin, int end)
246         throws com.liferay.portal.SystemException;
247 
248     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntriesAndShortcuts(
249         java.util.List<Long> folderIds, int begin, int end)
250         throws com.liferay.portal.SystemException;
251 
252     public int getFileEntriesAndShortcutsCount(long folderId)
253         throws com.liferay.portal.SystemException;
254 
255     public int getFileEntriesAndShortcutsCount(java.util.List<Long> folderIds)
256         throws com.liferay.portal.SystemException;
257 
258     public int getFileEntriesCount(long folderId)
259         throws com.liferay.portal.SystemException;
260 
261     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
262         long fileEntryId)
263         throws com.liferay.portal.SystemException,
264             com.liferay.portal.PortalException;
265 
266     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
267         long folderId, java.lang.String name)
268         throws com.liferay.portal.SystemException,
269             com.liferay.portal.PortalException;
270 
271     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
272         java.lang.String uuid, long groupId)
273         throws com.liferay.portal.SystemException,
274             com.liferay.portal.PortalException;
275 
276     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
277         long folderId, java.lang.String titleWithExtension)
278         throws com.liferay.portal.SystemException,
279             com.liferay.portal.PortalException;
280 
281     public int getFoldersFileEntriesCount(java.util.List<Long> folderIds)
282         throws com.liferay.portal.SystemException;
283 
284     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
285         long groupId, int begin, int end)
286         throws com.liferay.portal.SystemException;
287 
288     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
289         long groupId, int begin, int end,
290         com.liferay.portal.kernel.util.OrderByComparator obc)
291         throws com.liferay.portal.SystemException;
292 
293     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
294         long groupId, long userId, int begin, int end)
295         throws com.liferay.portal.SystemException;
296 
297     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
298         long groupId, long userId, int begin, int end,
299         com.liferay.portal.kernel.util.OrderByComparator obc)
300         throws com.liferay.portal.SystemException;
301 
302     public int getGroupFileEntriesCount(long groupId)
303         throws com.liferay.portal.SystemException;
304 
305     public int getGroupFileEntriesCount(long groupId, long userId)
306         throws com.liferay.portal.SystemException;
307 
308     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
309         throws com.liferay.portal.SystemException;
310 
311     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
312         long userId, long folderId, long newFolderId, java.lang.String name,
313         java.lang.String sourceFileName, java.lang.String title,
314         java.lang.String description, java.lang.String[] tagsEntries,
315         java.lang.String extraSettings, java.io.File file)
316         throws com.liferay.portal.SystemException,
317             com.liferay.portal.PortalException;
318 
319     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
320         long userId, long folderId, long newFolderId, java.lang.String name,
321         java.lang.String sourceFileName, java.lang.String title,
322         java.lang.String description, java.lang.String[] tagsEntries,
323         java.lang.String extraSettings, byte[] byteArray)
324         throws com.liferay.portal.SystemException,
325             com.liferay.portal.PortalException;
326 
327     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
328         long userId, long folderId, long newFolderId, java.lang.String name,
329         java.lang.String sourceFileName, java.lang.String title,
330         java.lang.String description, java.lang.String[] tagsEntries,
331         java.lang.String extraSettings, java.io.InputStream is, long size)
332         throws com.liferay.portal.SystemException,
333             com.liferay.portal.PortalException;
334 
335     public void updateTagsAsset(long userId,
336         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
337         java.lang.String[] tagsEntries)
338         throws com.liferay.portal.SystemException,
339             com.liferay.portal.PortalException;
340 }