1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.documentlibrary.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Isolation;
25  import com.liferay.portal.kernel.annotation.Propagation;
26  import com.liferay.portal.kernel.annotation.Transactional;
27  
28  /**
29   * <a href="DLFileEntryLocalService.java.html"><b><i>View Source</i></b></a>
30   *
31   * <p>
32   * ServiceBuilder generated this class. Modifications in this class will be
33   * overwritten the next time is generated.
34   * </p>
35   *
36   * <p>
37   * This interface defines the service. The default implementation is
38   * <code>com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl</code>.
39   * Modify methods in that class and rerun ServiceBuilder to populate this class
40   * and all other generated classes.
41   * </p>
42   *
43   * <p>
44   * 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.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryLocalServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface DLFileEntryLocalService {
55      public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
56          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
57          throws com.liferay.portal.SystemException;
58  
59      public com.liferay.portlet.documentlibrary.model.DLFileEntry createDLFileEntry(
60          long fileEntryId);
61  
62      public void deleteDLFileEntry(long fileEntryId)
63          throws com.liferay.portal.SystemException,
64              com.liferay.portal.PortalException;
65  
66      public void deleteDLFileEntry(
67          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
68          throws com.liferay.portal.SystemException;
69  
70      public java.util.List<Object> dynamicQuery(
71          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
72          throws com.liferay.portal.SystemException;
73  
74      public java.util.List<Object> dynamicQuery(
75          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
76          int end) throws com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntry(
80          long fileEntryId)
81          throws com.liferay.portal.SystemException,
82              com.liferay.portal.PortalException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDLFileEntries(
86          int start, int end) throws com.liferay.portal.SystemException;
87  
88      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
89      public int getDLFileEntriesCount()
90          throws com.liferay.portal.SystemException;
91  
92      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
93          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
94          throws com.liferay.portal.SystemException;
95  
96      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
97          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
98          boolean merge) throws com.liferay.portal.SystemException;
99  
100     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
101         long userId, long folderId, java.lang.String name,
102         java.lang.String title, java.lang.String description,
103         java.lang.String[] tagsEntries, java.lang.String extraSettings,
104         java.io.File file, boolean addCommunityPermissions,
105         boolean addGuestPermissions)
106         throws com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
110         long userId, long folderId, java.lang.String name,
111         java.lang.String title, java.lang.String description,
112         java.lang.String[] tagsEntries, java.lang.String extraSettings,
113         byte[] bytes, boolean addCommunityPermissions,
114         boolean addGuestPermissions)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
119         java.lang.String uuid, long userId, long folderId,
120         java.lang.String name, java.lang.String title,
121         java.lang.String description, java.lang.String[] tagsEntries,
122         java.lang.String extraSettings, byte[] bytes,
123         boolean addCommunityPermissions, boolean addGuestPermissions)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
128         long userId, long folderId, java.lang.String name,
129         java.lang.String title, java.lang.String description,
130         java.lang.String[] tagsEntries, java.lang.String extraSettings,
131         java.io.File file, java.lang.String[] communityPermissions,
132         java.lang.String[] guestPermissions)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException;
135 
136     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
137         long userId, long folderId, java.lang.String name,
138         java.lang.String title, java.lang.String description,
139         java.lang.String[] tagsEntries, java.lang.String extraSettings,
140         byte[] bytes, 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         long userId, long folderId, java.lang.String name,
147         java.lang.String title, java.lang.String description,
148         java.lang.String[] tagsEntries, java.lang.String extraSettings,
149         java.io.File file, java.lang.Boolean addCommunityPermissions,
150         java.lang.Boolean addGuestPermissions,
151         java.lang.String[] communityPermissions,
152         java.lang.String[] guestPermissions)
153         throws com.liferay.portal.PortalException,
154             com.liferay.portal.SystemException;
155 
156     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
157         java.lang.String uuid, long userId, long folderId,
158         java.lang.String name, java.lang.String title,
159         java.lang.String description, java.lang.String[] tagsEntries,
160         java.lang.String extraSettings, byte[] bytes,
161         java.lang.Boolean addCommunityPermissions,
162         java.lang.Boolean addGuestPermissions,
163         java.lang.String[] communityPermissions,
164         java.lang.String[] guestPermissions)
165         throws com.liferay.portal.PortalException,
166             com.liferay.portal.SystemException;
167 
168     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
169         java.lang.String uuid, long userId, long folderId,
170         java.lang.String name, java.lang.String title,
171         java.lang.String description, java.lang.String[] tagsEntries,
172         java.lang.String extraSettings, java.io.InputStream is, long size,
173         java.lang.Boolean addCommunityPermissions,
174         java.lang.Boolean addGuestPermissions,
175         java.lang.String[] communityPermissions,
176         java.lang.String[] guestPermissions)
177         throws com.liferay.portal.PortalException,
178             com.liferay.portal.SystemException;
179 
180     public void addFileEntryResources(long fileEntryId,
181         boolean addCommunityPermissions, boolean addGuestPermissions)
182         throws com.liferay.portal.PortalException,
183             com.liferay.portal.SystemException;
184 
185     public void addFileEntryResources(
186         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
187         boolean addCommunityPermissions, boolean addGuestPermissions)
188         throws com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException;
190 
191     public void addFileEntryResources(long fileEntryId,
192         java.lang.String[] communityPermissions,
193         java.lang.String[] guestPermissions)
194         throws com.liferay.portal.PortalException,
195             com.liferay.portal.SystemException;
196 
197     public void addFileEntryResources(
198         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
199         java.lang.String[] communityPermissions,
200         java.lang.String[] guestPermissions)
201         throws com.liferay.portal.PortalException,
202             com.liferay.portal.SystemException;
203 
204     public com.liferay.portlet.documentlibrary.model.DLFileEntry addOrOverwriteFileEntry(
205         long userId, long folderId, java.lang.String name,
206         java.lang.String sourceName, java.lang.String title,
207         java.lang.String description, java.lang.String[] tagsEntries,
208         java.lang.String extraSettings, java.io.File file,
209         boolean addCommunityPermissions, boolean addGuestPermissions)
210         throws com.liferay.portal.PortalException,
211             com.liferay.portal.SystemException;
212 
213     public void deleteFileEntries(long folderId)
214         throws com.liferay.portal.PortalException,
215             com.liferay.portal.SystemException;
216 
217     public void deleteFileEntry(long folderId, java.lang.String name)
218         throws com.liferay.portal.PortalException,
219             com.liferay.portal.SystemException;
220 
221     public void deleteFileEntry(long folderId, java.lang.String name,
222         double version)
223         throws com.liferay.portal.PortalException,
224             com.liferay.portal.SystemException;
225 
226     public void deleteFileEntry(
227         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
228         throws com.liferay.portal.PortalException,
229             com.liferay.portal.SystemException;
230 
231     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
233         long companyId, int start, int end)
234         throws com.liferay.portal.SystemException;
235 
236     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
238         long companyId, int start, int end,
239         com.liferay.portal.kernel.util.OrderByComparator obc)
240         throws com.liferay.portal.SystemException;
241 
242     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243     public int getCompanyFileEntriesCount(long companyId)
244         throws com.liferay.portal.SystemException;
245 
246     public java.io.InputStream getFileAsStream(long companyId, long userId,
247         long folderId, java.lang.String name)
248         throws com.liferay.portal.PortalException,
249             com.liferay.portal.SystemException;
250 
251     public java.io.InputStream getFileAsStream(long companyId, long userId,
252         long folderId, java.lang.String name, double version)
253         throws com.liferay.portal.PortalException,
254             com.liferay.portal.SystemException;
255 
256     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
258         long folderId) throws com.liferay.portal.SystemException;
259 
260     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
262         long folderId, int start, int end)
263         throws com.liferay.portal.SystemException;
264 
265     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
267         long folderId, int start, int end,
268         com.liferay.portal.kernel.util.OrderByComparator obc)
269         throws com.liferay.portal.SystemException;
270 
271     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272     public java.util.List<Object> getFileEntriesAndShortcuts(long folderId,
273         int start, int end) throws com.liferay.portal.SystemException;
274 
275     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276     public java.util.List<Object> getFileEntriesAndShortcuts(
277         java.util.List<Long> folderIds, int start, int end)
278         throws com.liferay.portal.SystemException;
279 
280     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281     public int getFileEntriesAndShortcutsCount(long folderId)
282         throws com.liferay.portal.SystemException;
283 
284     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285     public int getFileEntriesAndShortcutsCount(java.util.List<Long> folderIds)
286         throws com.liferay.portal.SystemException;
287 
288     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289     public int getFileEntriesCount(long folderId)
290         throws com.liferay.portal.SystemException;
291 
292     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
294         long fileEntryId)
295         throws com.liferay.portal.PortalException,
296             com.liferay.portal.SystemException;
297 
298     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
300         long folderId, java.lang.String name)
301         throws com.liferay.portal.PortalException,
302             com.liferay.portal.SystemException;
303 
304     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
306         java.lang.String uuid, long groupId)
307         throws com.liferay.portal.PortalException,
308             com.liferay.portal.SystemException;
309 
310     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
312         long folderId, java.lang.String titleWithExtension)
313         throws com.liferay.portal.PortalException,
314             com.liferay.portal.SystemException;
315 
316     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317     public int getFoldersFileEntriesCount(java.util.List<Long> folderIds)
318         throws com.liferay.portal.SystemException;
319 
320     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
322         long groupId, int start, int end)
323         throws com.liferay.portal.SystemException;
324 
325     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
327         long groupId, int start, int end,
328         com.liferay.portal.kernel.util.OrderByComparator obc)
329         throws com.liferay.portal.SystemException;
330 
331     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
333         long groupId, long userId, int start, int end)
334         throws com.liferay.portal.SystemException;
335 
336     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
338         long groupId, long userId, int start, int end,
339         com.liferay.portal.kernel.util.OrderByComparator obc)
340         throws com.liferay.portal.SystemException;
341 
342     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343     public int getGroupFileEntriesCount(long groupId)
344         throws com.liferay.portal.SystemException;
345 
346     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347     public int getGroupFileEntriesCount(long groupId, long userId)
348         throws com.liferay.portal.SystemException;
349 
350     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
352         throws com.liferay.portal.SystemException;
353 
354     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
355         long userId, long folderId, long newFolderId, java.lang.String name,
356         java.lang.String sourceFileName, java.lang.String title,
357         java.lang.String description, java.lang.String[] tagsEntries,
358         java.lang.String extraSettings, java.io.File file)
359         throws com.liferay.portal.PortalException,
360             com.liferay.portal.SystemException;
361 
362     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
363         long userId, long folderId, long newFolderId, java.lang.String name,
364         java.lang.String sourceFileName, java.lang.String title,
365         java.lang.String description, java.lang.String[] tagsEntries,
366         java.lang.String extraSettings, byte[] bytes)
367         throws com.liferay.portal.PortalException,
368             com.liferay.portal.SystemException;
369 
370     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
371         long userId, long folderId, long newFolderId, java.lang.String name,
372         java.lang.String sourceFileName, java.lang.String title,
373         java.lang.String description, java.lang.String[] tagsEntries,
374         java.lang.String extraSettings, java.io.InputStream is, long size)
375         throws com.liferay.portal.PortalException,
376             com.liferay.portal.SystemException;
377 
378     public void updateTagsAsset(long userId,
379         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
380         java.lang.String[] tagsEntries)
381         throws com.liferay.portal.PortalException,
382             com.liferay.portal.SystemException;
383 }