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 extraSettings,
61          java.io.File file,
62          com.liferay.portal.service.ServiceContext serviceContext)
63          throws 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 extraSettings,
69          byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
70          throws com.liferay.portal.PortalException,
71              com.liferay.portal.SystemException;
72  
73      public void deleteFileEntry(long folderId, java.lang.String name)
74          throws com.liferay.portal.PortalException,
75              com.liferay.portal.SystemException;
76  
77      public void deleteFileEntry(long folderId, java.lang.String name,
78          double version)
79          throws com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException;
81  
82      public void deleteFileEntryByTitle(long folderId,
83          java.lang.String titleWithExtension)
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> getFileEntries(
89          long folderId)
90          throws com.liferay.portal.PortalException,
91              com.liferay.portal.SystemException;
92  
93      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
94      public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
95          long folderId, java.lang.String name)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
100     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
101         long folderId, java.lang.String titleWithExtension)
102         throws com.liferay.portal.PortalException,
103             com.liferay.portal.SystemException;
104 
105     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106     public boolean hasFileEntryLock(long folderId, java.lang.String name)
107         throws com.liferay.portal.PortalException;
108 
109     public com.liferay.lock.model.Lock lockFileEntry(long folderId,
110         java.lang.String name)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     public com.liferay.lock.model.Lock lockFileEntry(long folderId,
115         java.lang.String name, java.lang.String owner, long expirationTime)
116         throws com.liferay.portal.PortalException,
117             com.liferay.portal.SystemException;
118 
119     public com.liferay.lock.model.Lock refreshFileEntryLock(
120         java.lang.String lockUuid, long expirationTime)
121         throws com.liferay.portal.PortalException;
122 
123     public void unlockFileEntry(long folderId, java.lang.String name);
124 
125     public void unlockFileEntry(long folderId, java.lang.String name,
126         java.lang.String lockUuid) throws com.liferay.portal.PortalException;
127 
128     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
129         long folderId, long newFolderId, java.lang.String name,
130         java.lang.String sourceFileName, java.lang.String title,
131         java.lang.String description, java.lang.String extraSettings,
132         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException;
135 
136     public boolean verifyFileEntryLock(long folderId, java.lang.String name,
137         java.lang.String lockUuid) throws com.liferay.portal.PortalException;
138 }