1   /**
2    * Copyright (c) 2000-2007 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   * <a href="DLFileEntryLocalService.java.html"><b><i>View Source</i></b></a>
27   *
28   * <p>
29   * ServiceBuilder generated this class. Modifications in this class will be overwritten
30   * the next time is generated.
31   * </p>
32   *
33   * <p>
34   * This interface defines the service. The default implementation is <code>com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl</code>.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * This is a local service. Methods of this service will not have security checks
41   * based on the propagated JAAS credentials because this service can only be accessed
42   * from within the same VM.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceFactory
48   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
49   *
50   */
51  public interface DLFileEntryLocalService {
52      public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
53          com.liferay.portlet.documentlibrary.model.DLFileEntry model)
54          throws com.liferay.portal.SystemException;
55  
56      public java.util.List dynamicQuery(
57          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
58          throws com.liferay.portal.SystemException;
59  
60      public java.util.List dynamicQuery(
61          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
62          int begin, int end) throws com.liferay.portal.SystemException;
63  
64      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
65          com.liferay.portlet.documentlibrary.model.DLFileEntry model)
66          throws com.liferay.portal.SystemException;
67  
68      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
69          long userId, long folderId, java.lang.String name,
70          java.lang.String title, java.lang.String description,
71          java.lang.String[] tagsEntries, java.lang.String extraSettings,
72          java.io.File file, boolean addCommunityPermissions,
73          boolean addGuestPermissions)
74          throws com.liferay.portal.SystemException, 
75              com.liferay.portal.PortalException;
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          byte[] byteArray, 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          java.io.File file, java.lang.String[] communityPermissions,
91          java.lang.String[] guestPermissions)
92          throws com.liferay.portal.SystemException, 
93              com.liferay.portal.PortalException;
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[] byteArray, java.lang.String[] communityPermissions,
100         java.lang.String[] guestPermissions)
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.Boolean addCommunityPermissions,
109         java.lang.Boolean addGuestPermissions,
110         java.lang.String[] communityPermissions,
111         java.lang.String[] guestPermissions)
112         throws com.liferay.portal.SystemException, 
113             com.liferay.portal.PortalException;
114 
115     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
116         long userId, long folderId, java.lang.String name,
117         java.lang.String title, java.lang.String description,
118         java.lang.String[] tagsEntries, java.lang.String extraSettings,
119         byte[] byteArray, java.lang.Boolean addCommunityPermissions,
120         java.lang.Boolean addGuestPermissions,
121         java.lang.String[] communityPermissions,
122         java.lang.String[] guestPermissions)
123         throws com.liferay.portal.SystemException, 
124             com.liferay.portal.PortalException;
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.InputStream is, long size,
131         java.lang.Boolean addCommunityPermissions,
132         java.lang.Boolean addGuestPermissions,
133         java.lang.String[] communityPermissions,
134         java.lang.String[] guestPermissions)
135         throws com.liferay.portal.SystemException, 
136             com.liferay.portal.PortalException;
137 
138     public void addFileEntryResources(long folderId, java.lang.String name,
139         boolean addCommunityPermissions, boolean addGuestPermissions)
140         throws com.liferay.portal.SystemException, 
141             com.liferay.portal.PortalException;
142 
143     public void addFileEntryResources(
144         com.liferay.portlet.documentlibrary.model.DLFolder folder,
145         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
146         boolean addCommunityPermissions, boolean addGuestPermissions)
147         throws com.liferay.portal.SystemException, 
148             com.liferay.portal.PortalException;
149 
150     public void addFileEntryResources(long folderId, java.lang.String name,
151         java.lang.String[] communityPermissions,
152         java.lang.String[] guestPermissions)
153         throws com.liferay.portal.SystemException, 
154             com.liferay.portal.PortalException;
155 
156     public void addFileEntryResources(
157         com.liferay.portlet.documentlibrary.model.DLFolder folder,
158         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
159         java.lang.String[] communityPermissions,
160         java.lang.String[] guestPermissions)
161         throws com.liferay.portal.SystemException, 
162             com.liferay.portal.PortalException;
163 
164     public void deleteFileEntries(long folderId)
165         throws com.liferay.portal.SystemException, 
166             com.liferay.portal.PortalException;
167 
168     public void deleteFileEntry(long folderId, java.lang.String name)
169         throws com.liferay.portal.SystemException, 
170             com.liferay.portal.PortalException;
171 
172     public void deleteFileEntry(long folderId, java.lang.String name,
173         double version)
174         throws com.liferay.portal.SystemException, 
175             com.liferay.portal.PortalException;
176 
177     public void deleteFileEntry(
178         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
179         throws com.liferay.portal.SystemException, 
180             com.liferay.portal.PortalException;
181 
182     public java.io.InputStream getFileAsStream(long companyId, long userId,
183         long folderId, java.lang.String name)
184         throws com.liferay.portal.SystemException, 
185             com.liferay.portal.PortalException;
186 
187     public java.io.InputStream getFileAsStream(long companyId, long userId,
188         long folderId, java.lang.String name, double version)
189         throws com.liferay.portal.SystemException, 
190             com.liferay.portal.PortalException;
191 
192     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
193         long fileEntryId)
194         throws com.liferay.portal.SystemException, 
195             com.liferay.portal.PortalException;
196 
197     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
198         long folderId, java.lang.String name)
199         throws com.liferay.portal.SystemException, 
200             com.liferay.portal.PortalException;
201 
202     public java.util.List getFileEntries(long folderId)
203         throws com.liferay.portal.SystemException;
204 
205     public java.util.List getFileEntries(long folderId, int begin, int end)
206         throws com.liferay.portal.SystemException;
207 
208     public java.util.List getFileEntries(long folderId, int begin, int end,
209         com.liferay.portal.kernel.util.OrderByComparator obc)
210         throws com.liferay.portal.SystemException;
211 
212     public java.util.List getFileEntriesAndShortcuts(long folderId, int begin,
213         int end) throws com.liferay.portal.SystemException;
214 
215     public java.util.List getFileEntriesAndShortcuts(java.util.List folderIds,
216         int begin, int end) throws com.liferay.portal.SystemException;
217 
218     public int getFileEntriesAndShortcutsCount(long folderId)
219         throws com.liferay.portal.SystemException;
220 
221     public int getFileEntriesAndShortcutsCount(java.util.List folderIds)
222         throws com.liferay.portal.SystemException;
223 
224     public int getFileEntriesCount(long folderId)
225         throws com.liferay.portal.SystemException;
226 
227     public int getFoldersFileEntriesCount(java.util.List folderIds)
228         throws com.liferay.portal.SystemException;
229 
230     public java.util.List getGroupFileEntries(long groupId, int begin, int end)
231         throws com.liferay.portal.SystemException;
232 
233     public java.util.List getGroupFileEntries(long groupId, int begin, int end,
234         com.liferay.portal.kernel.util.OrderByComparator obc)
235         throws com.liferay.portal.SystemException;
236 
237     public java.util.List getGroupFileEntries(long groupId, long userId,
238         int begin, int end) throws com.liferay.portal.SystemException;
239 
240     public java.util.List getGroupFileEntries(long groupId, long userId,
241         int begin, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
242         throws com.liferay.portal.SystemException;
243 
244     public int getGroupFileEntriesCount(long groupId)
245         throws com.liferay.portal.SystemException;
246 
247     public int getGroupFileEntriesCount(long groupId, long userId)
248         throws com.liferay.portal.SystemException;
249 
250     public java.util.List getNoAssetFileEntries()
251         throws com.liferay.portal.SystemException;
252 
253     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
254         long userId, long folderId, long newFolderId, java.lang.String name,
255         java.lang.String sourceFileName, java.lang.String title,
256         java.lang.String description, java.lang.String[] tagsEntries,
257         java.lang.String extraSettings, java.io.File file)
258         throws com.liferay.portal.SystemException, 
259             com.liferay.portal.PortalException;
260 
261     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
262         long userId, long folderId, long newFolderId, java.lang.String name,
263         java.lang.String sourceFileName, java.lang.String title,
264         java.lang.String description, java.lang.String[] tagsEntries,
265         java.lang.String extraSettings, byte[] byteArray)
266         throws com.liferay.portal.SystemException, 
267             com.liferay.portal.PortalException;
268 
269     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
270         long userId, long folderId, long newFolderId, java.lang.String name,
271         java.lang.String sourceFileName, java.lang.String title,
272         java.lang.String description, java.lang.String[] tagsEntries,
273         java.lang.String extraSettings, java.io.InputStream is, long size)
274         throws com.liferay.portal.SystemException, 
275             com.liferay.portal.PortalException;
276 
277     public void updateTagsAsset(long userId,
278         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
279         java.lang.String[] tagsEntries)
280         throws com.liferay.portal.SystemException, 
281             com.liferay.portal.PortalException;
282 }