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