1   /**
2    * Copyright (c) 2000-2008 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  
26  /**
27   * <a href="DLFileEntryService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
48   *
49   */
50  public interface DLFileEntryService {
51      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
52          long folderId, java.lang.String name, java.lang.String title,
53          java.lang.String description, java.lang.String[] tagsEntries,
54          java.lang.String extraSettings, java.io.File file,
55          boolean addCommunityPermissions, boolean addGuestPermissions)
56          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
57              com.liferay.portal.SystemException;
58  
59      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
60          long folderId, java.lang.String name, java.lang.String title,
61          java.lang.String description, java.lang.String[] tagsEntries,
62          java.lang.String extraSettings, byte[] bytes,
63          boolean addCommunityPermissions, boolean addGuestPermissions)
64          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
65              com.liferay.portal.SystemException;
66  
67      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
68          long folderId, java.lang.String name, java.lang.String title,
69          java.lang.String description, java.lang.String[] tagsEntries,
70          java.lang.String extraSettings, java.io.File file,
71          java.lang.String[] communityPermissions,
72          java.lang.String[] guestPermissions)
73          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
74              com.liferay.portal.SystemException;
75  
76      public com.liferay.portlet.documentlibrary.model.DLFileEntry addFileEntry(
77          long folderId, java.lang.String name, java.lang.String title,
78          java.lang.String description, java.lang.String[] tagsEntries,
79          java.lang.String extraSettings, byte[] bytes,
80          java.lang.String[] communityPermissions,
81          java.lang.String[] guestPermissions)
82          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
83              com.liferay.portal.SystemException;
84  
85      public void deleteFileEntry(long folderId, java.lang.String name)
86          throws com.liferay.portal.PortalException,
87              com.liferay.portal.SystemException, java.rmi.RemoteException;
88  
89      public void deleteFileEntry(long folderId, java.lang.String name,
90          double version)
91          throws com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException, java.rmi.RemoteException;
93  
94      public void deleteFileEntryByTitle(long folderId,
95          java.lang.String titleWithExtension)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException, java.rmi.RemoteException;
98  
99      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileEntry> getFileEntries(
100         long folderId)
101         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
102             com.liferay.portal.SystemException;
103 
104     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntry(
105         long folderId, java.lang.String name)
106         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     public com.liferay.portlet.documentlibrary.model.DLFileEntry getFileEntryByTitle(
110         long folderId, java.lang.String titleWithExtension)
111         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     public void lockFileEntry(long folderId, java.lang.String name)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException, java.rmi.RemoteException;
117 
118     public void unlockFileEntry(long folderId, java.lang.String name)
119         throws java.rmi.RemoteException;
120 
121     public com.liferay.portlet.documentlibrary.model.DLFileEntry updateFileEntry(
122         long folderId, long newFolderId, java.lang.String name,
123         java.lang.String sourceFileName, java.lang.String title,
124         java.lang.String description, java.lang.String[] tagsEntries,
125         java.lang.String extraSettings, byte[] bytes)
126         throws com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException, java.rmi.RemoteException;
128 }