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