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="DLFileEntryService.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.DLFileEntryServiceImpl</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 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.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface DLFileEntryService {
55      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
56          long folderId, java.lang.String name, java.lang.String title,
57          java.lang.String description, java.lang.String extraSettings,
58          java.io.File file,
59          com.liferay.portal.service.ServiceContext serviceContext)
60          throws com.liferay.portal.PortalException,
61              com.liferay.portal.SystemException;
62  
63      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
64          long folderId, java.lang.String name, java.lang.String title,
65          java.lang.String description, java.lang.String extraSettings,
66          byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
67          throws com.liferay.portal.PortalException,
68              com.liferay.portal.SystemException;
69  
70      public void deleteFileEntry(long folderId, java.lang.String name)
71          throws com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException;
73  
74      public void deleteFileEntry(long folderId, java.lang.String name,
75          double version)
76          throws com.liferay.portal.PortalException,
77              com.liferay.portal.SystemException;
78  
79      public void deleteFileEntryByTitle(long folderId,
80          java.lang.String titleWithExtension)
81          throws com.liferay.portal.PortalException,
82              com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
86          long folderId)
87          throws com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException;
89  
90      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
91      public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
92          long folderId, java.lang.String name)
93          throws com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException;
95  
96      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
97      public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
98          long folderId, java.lang.String titleWithExtension)
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException;
101 
102     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
103     public boolean hasFileEntryLock(long folderId, java.lang.String name)
104         throws com.liferay.portal.PortalException;
105 
106     public com.liferay.lock.model.Lock lockFileEntry(long folderId,
107         java.lang.String name)
108         throws com.liferay.portal.PortalException,
109             com.liferay.portal.SystemException;
110 
111     public com.liferay.lock.model.Lock lockFileEntry(long folderId,
112         java.lang.String name, java.lang.String owner, long expirationTime)
113         throws com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException;
115 
116     public com.liferay.lock.model.Lock refreshFileEntryLock(
117         java.lang.String lockUuid, long expirationTime)
118         throws com.liferay.portal.PortalException;
119 
120     public void unlockFileEntry(long folderId, java.lang.String name);
121 
122     public void unlockFileEntry(long folderId, java.lang.String name,
123         java.lang.String lockUuid) throws com.liferay.portal.PortalException;
124 
125     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
126         long folderId, long newFolderId, java.lang.String name,
127         java.lang.String sourceFileName, java.lang.String title,
128         java.lang.String description, java.lang.String extraSettings,
129         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
130         throws com.liferay.portal.PortalException,
131             com.liferay.portal.SystemException;
132 
133     public boolean verifyFileEntryLock(long folderId, java.lang.String name,
134         java.lang.String lockUuid) throws com.liferay.portal.PortalException;
135 }