1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portlet.documentlibrary.service;
16  
17  import com.liferay.portal.kernel.annotation.Isolation;
18  import com.liferay.portal.kernel.annotation.Propagation;
19  import com.liferay.portal.kernel.annotation.Transactional;
20  import com.liferay.portal.kernel.exception.PortalException;
21  import com.liferay.portal.kernel.exception.SystemException;
22  
23  /**
24   * <a href="DLFileEntryService.java.html"><b><i>View Source</i></b></a>
25   *
26   * <p>
27   * ServiceBuilder generated this class. Modifications in this class will be
28   * overwritten the next time is generated.
29   * </p>
30   *
31   * <p>
32   * This interface defines the service. The default implementation is
33   * {@link
34   * com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl}}.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * 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.
41   * </p>
42   *
43   * @author    Brian Wing Shun Chan
44   * @see       DLFileEntryServiceUtil
45   * @generated
46   */
47  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
48      PortalException.class, SystemException.class})
49  public interface DLFileEntryService {
50      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
51          long groupId, long folderId, java.lang.String name,
52          java.lang.String title, java.lang.String description,
53          java.lang.String versionDescription, java.lang.String extraSettings,
54          byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext)
55          throws com.liferay.portal.kernel.exception.PortalException,
56              com.liferay.portal.kernel.exception.SystemException;
57  
58      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
59          long groupId, long folderId, java.lang.String name,
60          java.lang.String title, java.lang.String description,
61          java.lang.String versionDescription, java.lang.String extraSettings,
62          java.io.File file,
63          com.liferay.portal.service.ServiceContext serviceContext)
64          throws com.liferay.portal.kernel.exception.PortalException,
65              com.liferay.portal.kernel.exception.SystemException;
66  
67      public void deleteFileEntry(long groupId, long folderId,
68          java.lang.String name)
69          throws com.liferay.portal.kernel.exception.PortalException,
70              com.liferay.portal.kernel.exception.SystemException;
71  
72      public void deleteFileEntry(long groupId, long folderId,
73          java.lang.String name, java.lang.String version)
74          throws com.liferay.portal.kernel.exception.PortalException,
75              com.liferay.portal.kernel.exception.SystemException;
76  
77      public void deleteFileEntryByTitle(long groupId, long folderId,
78          java.lang.String titleWithExtension)
79          throws com.liferay.portal.kernel.exception.PortalException,
80              com.liferay.portal.kernel.exception.SystemException;
81  
82      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
83      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
84          long groupId, long folderId)
85          throws com.liferay.portal.kernel.exception.PortalException,
86              com.liferay.portal.kernel.exception.SystemException;
87  
88      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
89      public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
90          long groupId, long folderId, java.lang.String name)
91          throws com.liferay.portal.kernel.exception.PortalException,
92              com.liferay.portal.kernel.exception.SystemException;
93  
94      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
95      public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
96          long groupId, long folderId, java.lang.String titleWithExtension)
97          throws com.liferay.portal.kernel.exception.PortalException,
98              com.liferay.portal.kernel.exception.SystemException;
99  
100     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
101     public boolean hasFileEntryLock(long groupId, long folderId,
102         java.lang.String name)
103         throws com.liferay.portal.kernel.exception.PortalException,
104             com.liferay.portal.kernel.exception.SystemException;
105 
106     public com.liferay.portal.model.Lock lockFileEntry(long groupId,
107         long folderId, java.lang.String name)
108         throws com.liferay.portal.kernel.exception.PortalException,
109             com.liferay.portal.kernel.exception.SystemException;
110 
111     public com.liferay.portal.model.Lock lockFileEntry(long groupId,
112         long folderId, java.lang.String name, java.lang.String owner,
113         long expirationTime)
114         throws com.liferay.portal.kernel.exception.PortalException,
115             com.liferay.portal.kernel.exception.SystemException;
116 
117     public com.liferay.portal.model.Lock refreshFileEntryLock(
118         java.lang.String lockUuid, long expirationTime)
119         throws com.liferay.portal.kernel.exception.PortalException,
120             com.liferay.portal.kernel.exception.SystemException;
121 
122     public void unlockFileEntry(long groupId, long folderId,
123         java.lang.String name)
124         throws com.liferay.portal.kernel.exception.SystemException;
125 
126     public void unlockFileEntry(long groupId, long folderId,
127         java.lang.String name, java.lang.String lockUuid)
128         throws com.liferay.portal.kernel.exception.PortalException,
129             com.liferay.portal.kernel.exception.SystemException;
130 
131     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
132         long groupId, long folderId, long newFolderId, java.lang.String name,
133         java.lang.String sourceFileName, java.lang.String title,
134         java.lang.String description, java.lang.String versionDescription,
135         boolean majorVersion, java.lang.String extraSettings, byte[] bytes,
136         com.liferay.portal.service.ServiceContext serviceContext)
137         throws com.liferay.portal.kernel.exception.PortalException,
138             com.liferay.portal.kernel.exception.SystemException;
139 
140     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
141         long groupId, long folderId, long newFolderId, java.lang.String name,
142         java.lang.String sourceFileName, java.lang.String title,
143         java.lang.String description, java.lang.String versionDescription,
144         boolean majorVersion, java.lang.String extraSettings,
145         java.io.File file,
146         com.liferay.portal.service.ServiceContext serviceContext)
147         throws com.liferay.portal.kernel.exception.PortalException,
148             com.liferay.portal.kernel.exception.SystemException;
149 
150     public boolean verifyFileEntryLock(long groupId, long folderId,
151         java.lang.String name, java.lang.String lockUuid)
152         throws com.liferay.portal.kernel.exception.PortalException,
153             com.liferay.portal.kernel.exception.SystemException;
154 }