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