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.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="DLFolderService.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This interface defines the service. The default implementation is
40   * <code>com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl</code>.
41   * Modify methods in that class and rerun ServiceBuilder to populate this class
42   * and all other generated classes.
43   * </p>
44   *
45   * <p>
46   * 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.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface DLFolderService {
57      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
58          long groupId, long parentFolderId, java.lang.String name,
59          java.lang.String description, boolean addCommunityPermissions,
60          boolean addGuestPermissions)
61          throws com.liferay.portal.PortalException,
62              com.liferay.portal.SystemException;
63  
64      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
65          long groupId, long parentFolderId, java.lang.String name,
66          java.lang.String description, java.lang.String[] communityPermissions,
67          java.lang.String[] guestPermissions)
68          throws com.liferay.portal.PortalException,
69              com.liferay.portal.SystemException;
70  
71      public com.liferay.portlet.documentlibrary.model.DLFolder copyFolder(
72          long groupId, long sourceFolderId, long parentFolderId,
73          java.lang.String name, java.lang.String description,
74          boolean addCommunityPermissions, boolean addGuestPermissions)
75          throws com.liferay.portal.PortalException,
76              com.liferay.portal.SystemException, java.rmi.RemoteException;
77  
78      public void deleteFolder(long folderId)
79          throws com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException, java.rmi.RemoteException;
81  
82      public void deleteFolder(long groupId, long parentFolderId,
83          java.lang.String name)
84          throws com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException, java.rmi.RemoteException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
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.DLFolder getFolder(
95          long groupId, long parentFolderId, 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 long getFolderId(long groupId, long parentFolderId,
101         java.lang.String name)
102         throws com.liferay.portal.PortalException,
103             com.liferay.portal.SystemException;
104 
105     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
107         long groupId, long parentFolderId)
108         throws com.liferay.portal.PortalException,
109             com.liferay.portal.SystemException;
110 
111     public boolean hasInheritableLock(long folderId)
112         throws com.liferay.portal.PortalException;
113 
114     public com.liferay.lock.model.Lock lockFolder(long folderId)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException, java.rmi.RemoteException;
117 
118     public com.liferay.lock.model.Lock lockFolder(long folderId,
119         java.lang.String owner, boolean inheritable, long expirationTime)
120         throws com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException, java.rmi.RemoteException;
122 
123     public com.liferay.lock.model.Lock refreshFolderLock(
124         java.lang.String lockUuid, long expirationTime)
125         throws com.liferay.portal.PortalException;
126 
127     public void reIndexSearch(long companyId)
128         throws com.liferay.portal.PortalException,
129             com.liferay.portal.SystemException;
130 
131     public void unlockFolder(long folderId, java.lang.String lockUuid)
132         throws com.liferay.portal.PortalException;
133 
134     public void unlockFolder(long groupId, long parentFolderId,
135         java.lang.String name, java.lang.String lockUuid)
136         throws com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException;
138 
139     public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
140         long folderId, long parentFolderId, java.lang.String name,
141         java.lang.String description)
142         throws com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException, java.rmi.RemoteException;
144 
145     public boolean verifyInheritableLock(long folderId,
146         java.lang.String lockUuid) throws com.liferay.portal.PortalException;
147 }