1   /**
2    * Copyright (c) 2000-2009 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  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="DLFileEntryService.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   * <code>com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl</code>.
42   * Modify methods in that class and rerun ServiceBuilder to populate this class
43   * and all other generated classes.
44   * </p>
45   *
46   * <p>
47   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
48   * </p>
49   *
50   * @author Brian Wing Shun Chan
51   *
52   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
53   *
54   */
55  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
56      PortalException.class, SystemException.class})
57  public interface DLFileEntryService {
58      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
59          long folderId, java.lang.String name, java.lang.String title,
60          java.lang.String description, java.lang.String[] tagsEntries,
61          java.lang.String extraSettings, java.io.File file,
62          boolean addCommunityPermissions, boolean addGuestPermissions)
63          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
64              com.liferay.portal.SystemException;
65  
66      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
67          long folderId, java.lang.String name, java.lang.String title,
68          java.lang.String description, java.lang.String[] tagsEntries,
69          java.lang.String extraSettings, byte[] bytes,
70          boolean addCommunityPermissions, boolean addGuestPermissions)
71          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException;
73  
74      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
75          long folderId, java.lang.String name, java.lang.String title,
76          java.lang.String description, java.lang.String[] tagsEntries,
77          java.lang.String extraSettings, java.io.File file,
78          java.lang.String[] communityPermissions,
79          java.lang.String[] guestPermissions)
80          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
81              com.liferay.portal.SystemException;
82  
83      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
84          long folderId, java.lang.String name, java.lang.String title,
85          java.lang.String description, java.lang.String[] tagsEntries,
86          java.lang.String extraSettings, byte[] bytes,
87          java.lang.String[] communityPermissions,
88          java.lang.String[] guestPermissions)
89          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException;
91  
92      public void deleteFileEntry(long folderId, java.lang.String name)
93          throws com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException, java.rmi.RemoteException;
95  
96      public void deleteFileEntry(long folderId, java.lang.String name,
97          double version)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException, java.rmi.RemoteException;
100 
101     public void deleteFileEntryByTitle(long folderId,
102         java.lang.String titleWithExtension)
103         throws com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException, java.rmi.RemoteException;
105 
106     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
107     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
108         long folderId)
109         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
110             com.liferay.portal.SystemException;
111 
112     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
114         long folderId, java.lang.String name)
115         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
119     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
120         long folderId, java.lang.String titleWithExtension)
121         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
122             com.liferay.portal.SystemException;
123 
124     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125     public com.liferay.lock.model.Lock getFileEntryLock(long folderId,
126         java.lang.String name)
127         throws com.liferay.portal.PortalException, java.rmi.RemoteException;
128 
129     public com.liferay.lock.model.Lock lockFileEntry(long folderId,
130         java.lang.String name)
131         throws com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException, java.rmi.RemoteException;
133 
134     public com.liferay.lock.model.Lock lockFileEntry(long folderId,
135         java.lang.String name, java.lang.String owner, long expirationTime)
136         throws com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException, java.rmi.RemoteException;
138 
139     public com.liferay.lock.model.Lock refreshFileEntryLock(
140         java.lang.String lockUuid, long expirationTime)
141         throws com.liferay.portal.PortalException, java.rmi.RemoteException;
142 
143     public void unlockFileEntry(long folderId, java.lang.String name)
144         throws java.rmi.RemoteException;
145 
146     public void unlockFileEntry(long folderId, java.lang.String name,
147         java.lang.String lockUuid)
148         throws com.liferay.portal.PortalException, java.rmi.RemoteException;
149 
150     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
151         long folderId, long newFolderId, java.lang.String name,
152         java.lang.String sourceFileName, java.lang.String title,
153         java.lang.String description, java.lang.String[] tagsEntries,
154         java.lang.String extraSettings, byte[] bytes)
155         throws com.liferay.portal.PortalException,
156             com.liferay.portal.SystemException, java.rmi.RemoteException;
157 }