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="DLFolderService.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.DLFolderServiceImpl}}.
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       DLFolderServiceUtil
45   * @generated
46   */
47  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
48      PortalException.class, SystemException.class})
49  public interface DLFolderService {
50      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
51          long groupId, long parentFolderId, java.lang.String name,
52          java.lang.String description,
53          com.liferay.portal.service.ServiceContext serviceContext)
54          throws com.liferay.portal.kernel.exception.PortalException,
55              com.liferay.portal.kernel.exception.SystemException;
56  
57      public com.liferay.portlet.documentlibrary.model.DLFolder copyFolder(
58          long groupId, long sourceFolderId, long parentFolderId,
59          java.lang.String name, java.lang.String description,
60          com.liferay.portal.service.ServiceContext serviceContext)
61          throws com.liferay.portal.kernel.exception.PortalException,
62              com.liferay.portal.kernel.exception.SystemException,
63              java.rmi.RemoteException;
64  
65      public void deleteFolder(long folderId)
66          throws com.liferay.portal.kernel.exception.PortalException,
67              com.liferay.portal.kernel.exception.SystemException,
68              java.rmi.RemoteException;
69  
70      public void deleteFolder(long groupId, long parentFolderId,
71          java.lang.String name)
72          throws com.liferay.portal.kernel.exception.PortalException,
73              com.liferay.portal.kernel.exception.SystemException,
74              java.rmi.RemoteException;
75  
76      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
77      public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
78          long groupId, java.util.List<java.lang.Long> folderIds, int status,
79          int start, int end)
80          throws com.liferay.portal.kernel.exception.SystemException;
81  
82      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
83      public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
84          long groupId, long folderId, int status, int start, int end)
85          throws com.liferay.portal.kernel.exception.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public int getFileEntriesAndFileShortcutsCount(long groupId,
89          java.util.List<java.lang.Long> folderIds, int status)
90          throws com.liferay.portal.kernel.exception.SystemException;
91  
92      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
93      public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
94          int status) throws com.liferay.portal.kernel.exception.SystemException;
95  
96      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
97      public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
98          long folderId)
99          throws com.liferay.portal.kernel.exception.PortalException,
100             com.liferay.portal.kernel.exception.SystemException;
101 
102     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
103     public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
104         long groupId, long parentFolderId, java.lang.String name)
105         throws com.liferay.portal.kernel.exception.PortalException,
106             com.liferay.portal.kernel.exception.SystemException;
107 
108     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
109     public long getFolderId(long groupId, long parentFolderId,
110         java.lang.String name)
111         throws com.liferay.portal.kernel.exception.PortalException,
112             com.liferay.portal.kernel.exception.SystemException;
113 
114     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
116         long groupId, long parentFolderId)
117         throws com.liferay.portal.kernel.exception.SystemException;
118 
119     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
121         long groupId, long parentFolderId, int start, int end)
122         throws com.liferay.portal.kernel.exception.SystemException;
123 
124     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125     public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
126         long groupId, java.util.List<java.lang.Long> folderIds, int status,
127         int start, int end)
128         throws com.liferay.portal.kernel.exception.SystemException;
129 
130     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
131     public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
132         long groupId, long folderId, int status, int start, int end)
133         throws com.liferay.portal.kernel.exception.PortalException,
134             com.liferay.portal.kernel.exception.SystemException;
135 
136     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137     public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
138         java.util.List<java.lang.Long> folderIds, int status)
139         throws com.liferay.portal.kernel.exception.SystemException;
140 
141     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142     public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
143         long folderId, int status)
144         throws com.liferay.portal.kernel.exception.PortalException,
145             com.liferay.portal.kernel.exception.SystemException;
146 
147     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
148     public int getFoldersCount(long groupId, long parentFolderId)
149         throws com.liferay.portal.kernel.exception.SystemException;
150 
151     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
152     public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
153         long groupId, long folderId)
154         throws com.liferay.portal.kernel.exception.PortalException,
155             com.liferay.portal.kernel.exception.SystemException;
156 
157     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158     public boolean hasInheritableLock(long folderId)
159         throws com.liferay.portal.kernel.exception.PortalException,
160             com.liferay.portal.kernel.exception.SystemException;
161 
162     public com.liferay.portal.model.Lock lockFolder(long folderId)
163         throws com.liferay.portal.kernel.exception.PortalException,
164             com.liferay.portal.kernel.exception.SystemException,
165             java.rmi.RemoteException;
166 
167     public com.liferay.portal.model.Lock lockFolder(long folderId,
168         java.lang.String owner, boolean inheritable, long expirationTime)
169         throws com.liferay.portal.kernel.exception.PortalException,
170             com.liferay.portal.kernel.exception.SystemException,
171             java.rmi.RemoteException;
172 
173     public com.liferay.portal.model.Lock refreshFolderLock(
174         java.lang.String lockUuid, long expirationTime)
175         throws com.liferay.portal.kernel.exception.PortalException,
176             com.liferay.portal.kernel.exception.SystemException;
177 
178     public void unlockFolder(long groupId, long folderId,
179         java.lang.String lockUuid)
180         throws com.liferay.portal.kernel.exception.PortalException,
181             com.liferay.portal.kernel.exception.SystemException;
182 
183     public void unlockFolder(long groupId, long parentFolderId,
184         java.lang.String name, java.lang.String lockUuid)
185         throws com.liferay.portal.kernel.exception.PortalException,
186             com.liferay.portal.kernel.exception.SystemException;
187 
188     public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
189         long folderId, long parentFolderId, java.lang.String name,
190         java.lang.String description,
191         com.liferay.portal.service.ServiceContext serviceContext)
192         throws com.liferay.portal.kernel.exception.PortalException,
193             com.liferay.portal.kernel.exception.SystemException,
194             java.rmi.RemoteException;
195 
196     public boolean verifyInheritableLock(long folderId,
197         java.lang.String lockUuid)
198         throws com.liferay.portal.kernel.exception.PortalException,
199             com.liferay.portal.kernel.exception.SystemException;
200 }