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="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   * {@link
42   * com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl}}.
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 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.
49   * </p>
50   *
51   * @author    Brian Wing Shun Chan
52   * @see       DLFileEntryServiceUtil
53   * @generated
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          byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
62          throws com.liferay.portal.PortalException,
63              com.liferay.portal.SystemException;
64  
65      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
66          long folderId, java.lang.String name, java.lang.String title,
67          java.lang.String description, java.lang.String extraSettings,
68          java.io.File file,
69          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             com.liferay.portal.SystemException;
109 
110     public com.liferay.portal.model.Lock lockFileEntry(long folderId,
111         java.lang.String name)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public com.liferay.portal.model.Lock lockFileEntry(long folderId,
116         java.lang.String name, java.lang.String owner, long expirationTime)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException;
119 
120     public com.liferay.portal.model.Lock refreshFileEntryLock(
121         java.lang.String lockUuid, long expirationTime)
122         throws com.liferay.portal.PortalException,
123             com.liferay.portal.SystemException;
124 
125     public void unlockFileEntry(long folderId, java.lang.String name)
126         throws com.liferay.portal.SystemException;
127 
128     public void unlockFileEntry(long folderId, java.lang.String name,
129         java.lang.String lockUuid)
130         throws com.liferay.portal.PortalException,
131             com.liferay.portal.SystemException;
132 
133     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
134         long folderId, long newFolderId, java.lang.String name,
135         java.lang.String sourceFileName, java.lang.String title,
136         java.lang.String description, java.lang.String extraSettings,
137         byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
138         throws com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException;
140 
141     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
142         long folderId, long newFolderId, java.lang.String name,
143         java.lang.String sourceFileName, java.lang.String title,
144         java.lang.String description, java.lang.String extraSettings,
145         java.io.File file,
146         com.liferay.portal.service.ServiceContext serviceContext)
147         throws com.liferay.portal.PortalException,
148             com.liferay.portal.SystemException;
149 
150     public boolean verifyFileEntryLock(long folderId, java.lang.String name,
151         java.lang.String lockUuid)
152         throws com.liferay.portal.PortalException,
153             com.liferay.portal.SystemException;
154 }