1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.documentlibrary.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Propagation;
25  import com.liferay.portal.kernel.annotation.Transactional;
26  
27  /**
28   * <a href="DLFolderLocalService.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This interface defines the service. The default implementation is
37   * <code>com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl</code>.
38   * Modify methods in that class and rerun ServiceBuilder to populate this class
39   * and all other generated classes.
40   * </p>
41   *
42   * <p>
43   * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
44   * </p>
45   *
46   * @author Brian Wing Shun Chan
47   *
48   * @see com.liferay.portlet.documentlibrary.service.DLFolderLocalServiceUtil
49   *
50   */
51  @Transactional(rollbackFor =  {
52      PortalException.class, SystemException.class})
53  public interface DLFolderLocalService {
54      public com.liferay.portlet.documentlibrary.model.DLFolder addDLFolder(
55          com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
56          throws com.liferay.portal.SystemException;
57  
58      public com.liferay.portlet.documentlibrary.model.DLFolder createDLFolder(
59          long folderId);
60  
61      public void deleteDLFolder(long folderId)
62          throws com.liferay.portal.SystemException,
63              com.liferay.portal.PortalException;
64  
65      public void deleteDLFolder(
66          com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
67          throws com.liferay.portal.SystemException;
68  
69      public java.util.List<Object> dynamicQuery(
70          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
71          throws com.liferay.portal.SystemException;
72  
73      public java.util.List<Object> dynamicQuery(
74          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
75          int end) throws com.liferay.portal.SystemException;
76  
77      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
78      public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolder(
79          long folderId)
80          throws com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException;
82  
83      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
84      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
85          int start, int end) throws com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public int getDLFoldersCount() throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
91          com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
92          throws com.liferay.portal.SystemException;
93  
94      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
95          long userId, long plid, long parentFolderId, java.lang.String name,
96          java.lang.String description, boolean addCommunityPermissions,
97          boolean addGuestPermissions)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
102         java.lang.String uuid, long userId, long plid, long parentFolderId,
103         java.lang.String name, java.lang.String description,
104         boolean addCommunityPermissions, boolean addGuestPermissions)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
109         long userId, long plid, long parentFolderId, java.lang.String name,
110         java.lang.String description, java.lang.String[] communityPermissions,
111         java.lang.String[] guestPermissions)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
116         java.lang.String uuid, long userId, long plid, long parentFolderId,
117         java.lang.String name, java.lang.String description,
118         java.lang.Boolean addCommunityPermissions,
119         java.lang.Boolean addGuestPermissions,
120         java.lang.String[] communityPermissions,
121         java.lang.String[] guestPermissions)
122         throws com.liferay.portal.PortalException,
123             com.liferay.portal.SystemException;
124 
125     public com.liferay.portlet.documentlibrary.model.DLFolder addFolderToGroup(
126         java.lang.String uuid, long userId, long groupId, long parentFolderId,
127         java.lang.String name, java.lang.String description,
128         java.lang.Boolean addCommunityPermissions,
129         java.lang.Boolean addGuestPermissions,
130         java.lang.String[] communityPermissions,
131         java.lang.String[] guestPermissions)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     public void addFolderResources(long folderId,
136         boolean addCommunityPermissions, boolean addGuestPermissions)
137         throws com.liferay.portal.PortalException,
138             com.liferay.portal.SystemException;
139 
140     public void addFolderResources(
141         com.liferay.portlet.documentlibrary.model.DLFolder folder,
142         boolean addCommunityPermissions, boolean addGuestPermissions)
143         throws com.liferay.portal.PortalException,
144             com.liferay.portal.SystemException;
145 
146     public void addFolderResources(long folderId,
147         java.lang.String[] communityPermissions,
148         java.lang.String[] guestPermissions)
149         throws com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException;
151 
152     public void addFolderResources(
153         com.liferay.portlet.documentlibrary.model.DLFolder folder,
154         java.lang.String[] communityPermissions,
155         java.lang.String[] guestPermissions)
156         throws com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException;
158 
159     public void deleteFolder(long folderId)
160         throws com.liferay.portal.PortalException,
161             com.liferay.portal.SystemException;
162 
163     public void deleteFolder(
164         com.liferay.portlet.documentlibrary.model.DLFolder folder)
165         throws com.liferay.portal.PortalException,
166             com.liferay.portal.SystemException;
167 
168     public void deleteFolders(long groupId)
169         throws com.liferay.portal.PortalException,
170             com.liferay.portal.SystemException;
171 
172     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173     public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
174         long folderId)
175         throws com.liferay.portal.PortalException,
176             com.liferay.portal.SystemException;
177 
178     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179     public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
180         long groupId, long parentFolderId, java.lang.String name)
181         throws com.liferay.portal.PortalException,
182             com.liferay.portal.SystemException;
183 
184     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
186         long companyId) throws com.liferay.portal.SystemException;
187 
188     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
190         long groupId, long parentFolderId)
191         throws com.liferay.portal.SystemException;
192 
193     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
195         long groupId, long parentFolderId, int start, int end)
196         throws com.liferay.portal.SystemException;
197 
198     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199     public int getFoldersCount(long groupId, long parentFolderId)
200         throws com.liferay.portal.SystemException;
201 
202     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203     public void getSubfolderIds(java.util.List<Long> folderIds, long groupId,
204         long folderId) throws com.liferay.portal.SystemException;
205 
206     public void reIndex(java.lang.String[] ids)
207         throws com.liferay.portal.SystemException;
208 
209     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210     public com.liferay.portal.kernel.search.Hits search(long companyId,
211         long groupId, long[] folderIds, java.lang.String keywords, int start,
212         int end) throws com.liferay.portal.SystemException;
213 
214     public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
215         long folderId, long parentFolderId, java.lang.String name,
216         java.lang.String description)
217         throws com.liferay.portal.PortalException,
218             com.liferay.portal.SystemException;
219 }