1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Isolation;
28  import com.liferay.portal.kernel.annotation.Propagation;
29  import com.liferay.portal.kernel.annotation.Transactional;
30  
31  /**
32   * <a href="DLFileEntryLocalService.java.html"><b><i>View Source</i></b></a>
33   *
34   * <p>
35   * ServiceBuilder generated this class. Modifications in this class will be
36   * overwritten the next time is generated.
37   * </p>
38   *
39   * <p>
40   * This interface defines the service. The default implementation is
41   * {@link
42   * com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl}}.
43   * Modify methods in that class and rerun ServiceBuilder to populate this class
44   * and all other generated classes.
45   * </p>
46   *
47   * <p>
48   * 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.
49   * </p>
50   *
51   * @author    Brian Wing Shun Chan
52   * @see       DLFileEntryLocalServiceUtil
53   * @generated
54   */
55  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
56      PortalException.class, SystemException.class})
57  public interface DLFileEntryLocalService {
58      public com.liferay.portlet.documentlibrary.model.DLFileEntry addDLFileEntry(
59          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
60          throws com.liferay.portal.SystemException;
61  
62      public com.liferay.portlet.documentlibrary.model.DLFileEntry createDLFileEntry(
63          long fileEntryId);
64  
65      public void deleteDLFileEntry(long fileEntryId)
66          throws com.liferay.portal.PortalException,
67              com.liferay.portal.SystemException;
68  
69      public void deleteDLFileEntry(
70          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
71          throws com.liferay.portal.SystemException;
72  
73      public java.util.List<Object> dynamicQuery(
74          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
75          throws com.liferay.portal.SystemException;
76  
77      public java.util.List<Object> dynamicQuery(
78          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
79          int end) throws com.liferay.portal.SystemException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public com.liferay.portlet.documentlibrary.model.DLFileEntry getDLFileEntry(
83          long fileEntryId)
84          throws com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getDLFileEntries(
89          int start, int end) throws com.liferay.portal.SystemException;
90  
91      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
92      public int getDLFileEntriesCount()
93          throws com.liferay.portal.SystemException;
94  
95      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
96          com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry)
97          throws com.liferay.portal.SystemException;
98  
99      public com.liferay.portlet.documentlibrary.model.DLFileEntry updateDLFileEntry(
100         com.liferay.portlet.documentlibrary.model.DLFileEntry dlFileEntry,
101         boolean merge) throws com.liferay.portal.SystemException;
102 
103     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
104         long userId, long folderId, java.lang.String name,
105         java.lang.String title, java.lang.String description,
106         java.lang.String extraSettings, byte[] bytes,
107         com.liferay.portal.service.ServiceContext serviceContext)
108         throws com.liferay.portal.PortalException,
109             com.liferay.portal.SystemException;
110 
111     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
112         long userId, long folderId, java.lang.String name,
113         java.lang.String title, java.lang.String description,
114         java.lang.String extraSettings, java.io.File file,
115         com.liferay.portal.service.ServiceContext serviceContext)
116         throws com.liferay.portal.PortalException,
117             com.liferay.portal.SystemException;
118 
119     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
120         long userId, long folderId, java.lang.String name,
121         java.lang.String title, java.lang.String description,
122         java.lang.String extraSettings, java.io.InputStream is, int size,
123         com.liferay.portal.service.ServiceContext serviceContext)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
128         java.lang.String uuid, long userId, long folderId,
129         java.lang.String name, java.lang.String title,
130         java.lang.String description, java.lang.String extraSettings,
131         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
136         java.lang.String uuid, long userId, long folderId,
137         java.lang.String name, java.lang.String title,
138         java.lang.String description, java.lang.String extraSettings,
139         java.io.File file,
140         com.liferay.portal.service.ServiceContext serviceContext)
141         throws com.liferay.portal.PortalException,
142             com.liferay.portal.SystemException;
143 
144     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
145         java.lang.String uuid, long userId, long folderId,
146         java.lang.String name, java.lang.String title,
147         java.lang.String description, java.lang.String extraSettings,
148         java.io.InputStream is, long size,
149         com.liferay.portal.service.ServiceContext serviceContext)
150         throws com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException;
152 
153     public void addFileEntryResources(
154         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
155         boolean addCommunityPermissions, boolean addGuestPermissions)
156         throws com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException;
158 
159     public void addFileEntryResources(
160         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
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 fileEntryId,
167         boolean addCommunityPermissions, boolean addGuestPermissions)
168         throws com.liferay.portal.PortalException,
169             com.liferay.portal.SystemException;
170 
171     public void addFileEntryResources(long fileEntryId,
172         java.lang.String[] communityPermissions,
173         java.lang.String[] guestPermissions)
174         throws com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException;
176 
177     public com.liferay.portlet.documentlibrary.model.DLFileEntry addOrOverwriteFileEntry(
178         long userId, long folderId, java.lang.String name,
179         java.lang.String sourceName, java.lang.String title,
180         java.lang.String description, java.lang.String extraSettings,
181         java.io.File file,
182         com.liferay.portal.service.ServiceContext serviceContext)
183         throws com.liferay.portal.PortalException,
184             com.liferay.portal.SystemException;
185 
186     public void deleteFileEntries(long folderId)
187         throws com.liferay.portal.PortalException,
188             com.liferay.portal.SystemException;
189 
190     public void deleteFileEntry(
191         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
192         throws com.liferay.portal.PortalException,
193             com.liferay.portal.SystemException;
194 
195     public void deleteFileEntry(long folderId, java.lang.String name)
196         throws com.liferay.portal.PortalException,
197             com.liferay.portal.SystemException;
198 
199     public void deleteFileEntry(long folderId, java.lang.String name,
200         double version)
201         throws com.liferay.portal.PortalException,
202             com.liferay.portal.SystemException;
203 
204     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
206         long companyId, int start, int end)
207         throws com.liferay.portal.SystemException;
208 
209     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
211         long companyId, int start, int end,
212         com.liferay.portal.kernel.util.OrderByComparator obc)
213         throws com.liferay.portal.SystemException;
214 
215     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216     public int getCompanyFileEntriesCount(long companyId)
217         throws com.liferay.portal.SystemException;
218 
219     public java.io.InputStream getFileAsStream(long companyId, long userId,
220         long folderId, java.lang.String name)
221         throws com.liferay.portal.PortalException,
222             com.liferay.portal.SystemException;
223 
224     public java.io.InputStream getFileAsStream(long companyId, long userId,
225         long folderId, java.lang.String name, double version)
226         throws com.liferay.portal.PortalException,
227             com.liferay.portal.SystemException;
228 
229     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
231         long folderId) throws com.liferay.portal.SystemException;
232 
233     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
234     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
235         long folderId, int start, int end)
236         throws com.liferay.portal.SystemException;
237 
238     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
239     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
240         long folderId, int start, int end,
241         com.liferay.portal.kernel.util.OrderByComparator obc)
242         throws com.liferay.portal.SystemException;
243 
244     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245     public int getFileEntriesCount(long folderId)
246         throws com.liferay.portal.SystemException;
247 
248     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
250         long fileEntryId)
251         throws com.liferay.portal.PortalException,
252             com.liferay.portal.SystemException;
253 
254     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
256         long folderId, java.lang.String name)
257         throws com.liferay.portal.PortalException,
258             com.liferay.portal.SystemException;
259 
260     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
262         long folderId, java.lang.String titleWithExtension)
263         throws com.liferay.portal.PortalException,
264             com.liferay.portal.SystemException;
265 
266     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
268         java.lang.String uuid, long groupId)
269         throws com.liferay.portal.PortalException,
270             com.liferay.portal.SystemException;
271 
272     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273     public int getFoldersFileEntriesCount(java.util.List<Long> folderIds)
274         throws com.liferay.portal.SystemException;
275 
276     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
278         long groupId, int start, int end)
279         throws com.liferay.portal.SystemException;
280 
281     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
282     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
283         long groupId, int start, int end,
284         com.liferay.portal.kernel.util.OrderByComparator obc)
285         throws com.liferay.portal.SystemException;
286 
287     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
288     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
289         long groupId, long userId, int start, int end)
290         throws com.liferay.portal.SystemException;
291 
292     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
294         long groupId, long userId, int start, int end,
295         com.liferay.portal.kernel.util.OrderByComparator obc)
296         throws com.liferay.portal.SystemException;
297 
298     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299     public int getGroupFileEntriesCount(long groupId)
300         throws com.liferay.portal.SystemException;
301 
302     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303     public int getGroupFileEntriesCount(long groupId, long userId)
304         throws com.liferay.portal.SystemException;
305 
306     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
308         throws com.liferay.portal.SystemException;
309 
310     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311     public void reIndex(long fileEntryId)
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 extraSettings,
318         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
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 extraSettings,
326         java.io.File file,
327         com.liferay.portal.service.ServiceContext serviceContext)
328         throws com.liferay.portal.PortalException,
329             com.liferay.portal.SystemException;
330 
331     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
332         long userId, long folderId, long newFolderId, java.lang.String name,
333         java.lang.String sourceFileName, java.lang.String title,
334         java.lang.String description, java.lang.String extraSettings,
335         java.io.InputStream is, long size,
336         com.liferay.portal.service.ServiceContext serviceContext)
337         throws com.liferay.portal.PortalException,
338             com.liferay.portal.SystemException;
339 
340     public void updateTagsAsset(long userId,
341         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
342         java.lang.String[] tagsCategories, java.lang.String[] tagsEntries)
343         throws com.liferay.portal.PortalException,
344             com.liferay.portal.SystemException;
345 }