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="DLFolderService.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.DLFolderServiceImpl</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.DLFolderServiceUtil
53   *
54   */
55  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
56      PortalException.class, SystemException.class})
57  public interface DLFolderService {
58      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
59          long groupId, long parentFolderId, java.lang.String name,
60          java.lang.String description,
61          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.DLFolder copyFolder(
66          long groupId, long sourceFolderId, long parentFolderId,
67          java.lang.String name, java.lang.String description,
68          com.liferay.portal.service.ServiceContext serviceContext)
69          throws com.liferay.portal.PortalException,
70              com.liferay.portal.SystemException, java.rmi.RemoteException;
71  
72      public void deleteFolder(long folderId)
73          throws com.liferay.portal.PortalException,
74              com.liferay.portal.SystemException, java.rmi.RemoteException;
75  
76      public void deleteFolder(long groupId, long parentFolderId,
77          java.lang.String name)
78          throws com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException, java.rmi.RemoteException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
83          long folderId)
84          throws com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
89          long groupId, long parentFolderId, java.lang.String name)
90          throws com.liferay.portal.PortalException,
91              com.liferay.portal.SystemException;
92  
93      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
94      public long getFolderId(long groupId, long parentFolderId,
95          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 java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
101         long groupId, long parentFolderId)
102         throws com.liferay.portal.PortalException,
103             com.liferay.portal.SystemException;
104 
105     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106     public boolean hasInheritableLock(long folderId)
107         throws com.liferay.portal.PortalException;
108 
109     public com.liferay.lock.model.Lock lockFolder(long folderId)
110         throws com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException, java.rmi.RemoteException;
112 
113     public com.liferay.lock.model.Lock lockFolder(long folderId,
114         java.lang.String owner, boolean inheritable, long expirationTime)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException, java.rmi.RemoteException;
117 
118     public com.liferay.lock.model.Lock refreshFolderLock(
119         java.lang.String lockUuid, long expirationTime)
120         throws com.liferay.portal.PortalException;
121 
122     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
123     public void reIndexSearch(long companyId)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public void unlockFolder(long folderId, java.lang.String lockUuid)
128         throws com.liferay.portal.PortalException;
129 
130     public void unlockFolder(long groupId, long parentFolderId,
131         java.lang.String name, java.lang.String lockUuid)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
136         long folderId, long parentFolderId, java.lang.String name,
137         java.lang.String description,
138         com.liferay.portal.service.ServiceContext serviceContext)
139         throws com.liferay.portal.PortalException,
140             com.liferay.portal.SystemException, java.rmi.RemoteException;
141 
142     public boolean verifyInheritableLock(long folderId,
143         java.lang.String lockUuid) throws com.liferay.portal.PortalException;
144 }