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 extraSettings, byte[] bytes,
104         com.liferay.portal.service.ServiceContext serviceContext)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
109         long userId, long folderId, java.lang.String name,
110         java.lang.String title, java.lang.String description,
111         java.lang.String extraSettings, java.io.File file,
112         com.liferay.portal.service.ServiceContext serviceContext)
113         throws com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException;
115 
116     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
117         java.lang.String uuid, long userId, long folderId,
118         java.lang.String name, java.lang.String title,
119         java.lang.String description, java.lang.String extraSettings,
120         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
121         throws com.liferay.portal.PortalException,
122             com.liferay.portal.SystemException;
123 
124     public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
125         java.lang.String uuid, long userId, long folderId,
126         java.lang.String name, java.lang.String title,
127         java.lang.String description, java.lang.String extraSettings,
128         java.io.InputStream is, long size,
129         com.liferay.portal.service.ServiceContext serviceContext)
130         throws com.liferay.portal.PortalException,
131             com.liferay.portal.SystemException;
132 
133     public void addFileEntryResources(long fileEntryId,
134         boolean addCommunityPermissions, boolean addGuestPermissions)
135         throws com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     public void addFileEntryResources(
139         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
140         boolean addCommunityPermissions, boolean addGuestPermissions)
141         throws com.liferay.portal.PortalException,
142             com.liferay.portal.SystemException;
143 
144     public void addFileEntryResources(long fileEntryId,
145         java.lang.String[] communityPermissions,
146         java.lang.String[] guestPermissions)
147         throws com.liferay.portal.PortalException,
148             com.liferay.portal.SystemException;
149 
150     public void addFileEntryResources(
151         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
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 addOrOverwriteFileEntry(
158         long userId, long folderId, java.lang.String name,
159         java.lang.String sourceName, java.lang.String title,
160         java.lang.String description, java.lang.String extraSettings,
161         java.io.File file,
162         com.liferay.portal.service.ServiceContext serviceContext)
163         throws com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException;
165 
166     public void deleteFileEntries(long folderId)
167         throws com.liferay.portal.PortalException,
168             com.liferay.portal.SystemException;
169 
170     public void deleteFileEntry(long folderId, java.lang.String name)
171         throws com.liferay.portal.PortalException,
172             com.liferay.portal.SystemException;
173 
174     public void deleteFileEntry(long folderId, java.lang.String name,
175         double version)
176         throws com.liferay.portal.PortalException,
177             com.liferay.portal.SystemException;
178 
179     public void deleteFileEntry(
180         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry)
181         throws com.liferay.portal.PortalException,
182             com.liferay.portal.SystemException;
183 
184     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
186         long companyId, int start, int end)
187         throws com.liferay.portal.SystemException;
188 
189     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getCompanyFileEntries(
191         long companyId, int start, int end,
192         com.liferay.portal.kernel.util.OrderByComparator obc)
193         throws com.liferay.portal.SystemException;
194 
195     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
196     public int getCompanyFileEntriesCount(long companyId)
197         throws com.liferay.portal.SystemException;
198 
199     public java.io.InputStream getFileAsStream(long companyId, long userId,
200         long folderId, java.lang.String name)
201         throws com.liferay.portal.PortalException,
202             com.liferay.portal.SystemException;
203 
204     public java.io.InputStream getFileAsStream(long companyId, long userId,
205         long folderId, java.lang.String name, double version)
206         throws com.liferay.portal.PortalException,
207             com.liferay.portal.SystemException;
208 
209     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
211         long folderId) throws com.liferay.portal.SystemException;
212 
213     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
215         long folderId, int start, int end)
216         throws com.liferay.portal.SystemException;
217 
218     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
220         long folderId, int start, int end,
221         com.liferay.portal.kernel.util.OrderByComparator obc)
222         throws com.liferay.portal.SystemException;
223 
224     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225     public int getFileEntriesCount(long folderId)
226         throws com.liferay.portal.SystemException;
227 
228     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
230         long fileEntryId)
231         throws com.liferay.portal.PortalException,
232             com.liferay.portal.SystemException;
233 
234     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
236         long folderId, java.lang.String name)
237         throws com.liferay.portal.PortalException,
238             com.liferay.portal.SystemException;
239 
240     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByUuidAndGroupId(
242         java.lang.String uuid, long groupId)
243         throws com.liferay.portal.PortalException,
244             com.liferay.portal.SystemException;
245 
246     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
248         long folderId, java.lang.String titleWithExtension)
249         throws com.liferay.portal.PortalException,
250             com.liferay.portal.SystemException;
251 
252     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253     public int getFoldersFileEntriesCount(java.util.List<Long> folderIds)
254         throws com.liferay.portal.SystemException;
255 
256     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
258         long groupId, int start, int end)
259         throws com.liferay.portal.SystemException;
260 
261     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
263         long groupId, int start, int end,
264         com.liferay.portal.kernel.util.OrderByComparator obc)
265         throws com.liferay.portal.SystemException;
266 
267     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
268     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
269         long groupId, long userId, int start, int end)
270         throws com.liferay.portal.SystemException;
271 
272     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getGroupFileEntries(
274         long groupId, long userId, int start, int end,
275         com.liferay.portal.kernel.util.OrderByComparator obc)
276         throws com.liferay.portal.SystemException;
277 
278     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279     public int getGroupFileEntriesCount(long groupId)
280         throws com.liferay.portal.SystemException;
281 
282     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283     public int getGroupFileEntriesCount(long groupId, long userId)
284         throws com.liferay.portal.SystemException;
285 
286     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getNoAssetFileEntries()
288         throws com.liferay.portal.SystemException;
289 
290     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291     public void reIndex(long fileEntryId)
292         throws com.liferay.portal.SystemException;
293 
294     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
295         long userId, long folderId, long newFolderId, java.lang.String name,
296         java.lang.String sourceFileName, java.lang.String title,
297         java.lang.String description, java.lang.String extraSettings,
298         java.io.File file,
299         com.liferay.portal.service.ServiceContext serviceContext)
300         throws com.liferay.portal.PortalException,
301             com.liferay.portal.SystemException;
302 
303     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
304         long userId, long folderId, long newFolderId, java.lang.String name,
305         java.lang.String sourceFileName, java.lang.String title,
306         java.lang.String description, java.lang.String extraSettings,
307         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
308         throws com.liferay.portal.PortalException,
309             com.liferay.portal.SystemException;
310 
311     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
312         long userId, long folderId, long newFolderId, java.lang.String name,
313         java.lang.String sourceFileName, java.lang.String title,
314         java.lang.String description, java.lang.String extraSettings,
315         java.io.InputStream is, long size,
316         com.liferay.portal.service.ServiceContext serviceContext)
317         throws com.liferay.portal.PortalException,
318             com.liferay.portal.SystemException;
319 
320     public void updateTagsAsset(long userId,
321         com.liferay.portlet.documentlibrary.model.DLFileEntry fileEntry,
322         java.lang.String[] tagsCategories, java.lang.String[] tagsEntries)
323         throws com.liferay.portal.PortalException,
324             com.liferay.portal.SystemException;
325 }