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="DLFolderLocalService.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.DLFolderLocalServiceImpl</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 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.documentlibrary.service.DLFolderLocalServiceUtil
48   *
49   */
50  public interface DLFolderLocalService {
51      public com.liferay.portlet.documentlibrary.model.DLFolder addDLFolder(
52          com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
53          throws com.liferay.portal.SystemException;
54  
55      public com.liferay.portlet.documentlibrary.model.DLFolder createDLFolder(
56          long folderId);
57  
58      public void deleteDLFolder(long folderId)
59          throws com.liferay.portal.SystemException,
60              com.liferay.portal.PortalException;
61  
62      public void deleteDLFolder(
63          com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
64          throws com.liferay.portal.SystemException;
65  
66      public java.util.List<Object> dynamicQuery(
67          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
68          throws com.liferay.portal.SystemException;
69  
70      public java.util.List<Object> dynamicQuery(
71          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
72          int end) throws com.liferay.portal.SystemException;
73  
74      public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolder(
75          long folderId)
76          throws com.liferay.portal.SystemException,
77              com.liferay.portal.PortalException;
78  
79      public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
80          int start, int end) throws com.liferay.portal.SystemException;
81  
82      public int getDLFoldersCount() throws com.liferay.portal.SystemException;
83  
84      public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
85          com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
86          throws com.liferay.portal.SystemException;
87  
88      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
89          long userId, long plid, long parentFolderId, java.lang.String name,
90          java.lang.String description, boolean addCommunityPermissions,
91          boolean addGuestPermissions)
92          throws com.liferay.portal.PortalException,
93              com.liferay.portal.SystemException;
94  
95      public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
96          java.lang.String uuid, long userId, long plid, long parentFolderId,
97          java.lang.String name, java.lang.String description,
98          boolean addCommunityPermissions, boolean addGuestPermissions)
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException;
101 
102     public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
103         long userId, long plid, long parentFolderId, java.lang.String name,
104         java.lang.String description, java.lang.String[] communityPermissions,
105         java.lang.String[] guestPermissions)
106         throws com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
110         java.lang.String uuid, long userId, long plid, long parentFolderId,
111         java.lang.String name, java.lang.String description,
112         java.lang.Boolean addCommunityPermissions,
113         java.lang.Boolean addGuestPermissions,
114         java.lang.String[] communityPermissions,
115         java.lang.String[] guestPermissions)
116         throws com.liferay.portal.PortalException,
117             com.liferay.portal.SystemException;
118 
119     public com.liferay.portlet.documentlibrary.model.DLFolder addFolderToGroup(
120         java.lang.String uuid, long userId, long groupId, long parentFolderId,
121         java.lang.String name, java.lang.String description,
122         java.lang.Boolean addCommunityPermissions,
123         java.lang.Boolean addGuestPermissions,
124         java.lang.String[] communityPermissions,
125         java.lang.String[] guestPermissions)
126         throws com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException;
128 
129     public void addFolderResources(long folderId,
130         boolean addCommunityPermissions, boolean addGuestPermissions)
131         throws com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException;
133 
134     public void addFolderResources(
135         com.liferay.portlet.documentlibrary.model.DLFolder folder,
136         boolean addCommunityPermissions, boolean addGuestPermissions)
137         throws com.liferay.portal.PortalException,
138             com.liferay.portal.SystemException;
139 
140     public void addFolderResources(long folderId,
141         java.lang.String[] communityPermissions,
142         java.lang.String[] guestPermissions)
143         throws com.liferay.portal.PortalException,
144             com.liferay.portal.SystemException;
145 
146     public void addFolderResources(
147         com.liferay.portlet.documentlibrary.model.DLFolder folder,
148         java.lang.String[] communityPermissions,
149         java.lang.String[] guestPermissions)
150         throws com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException;
152 
153     public void deleteFolder(long folderId)
154         throws com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException;
156 
157     public void deleteFolder(
158         com.liferay.portlet.documentlibrary.model.DLFolder folder)
159         throws com.liferay.portal.PortalException,
160             com.liferay.portal.SystemException;
161 
162     public void deleteFolders(long groupId)
163         throws com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException;
165 
166     public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
167         long folderId)
168         throws com.liferay.portal.PortalException,
169             com.liferay.portal.SystemException;
170 
171     public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
172         long groupId, long parentFolderId, java.lang.String name)
173         throws com.liferay.portal.PortalException,
174             com.liferay.portal.SystemException;
175 
176     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
177         long companyId) throws com.liferay.portal.SystemException;
178 
179     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
180         long groupId, long parentFolderId)
181         throws com.liferay.portal.SystemException;
182 
183     public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
184         long groupId, long parentFolderId, int start, int end)
185         throws com.liferay.portal.SystemException;
186 
187     public int getFoldersCount(long groupId, long parentFolderId)
188         throws com.liferay.portal.SystemException;
189 
190     public void getSubfolderIds(java.util.List<Long> folderIds, long groupId,
191         long folderId) throws com.liferay.portal.SystemException;
192 
193     public void reIndex(java.lang.String[] ids)
194         throws com.liferay.portal.SystemException;
195 
196     public com.liferay.portal.kernel.search.Hits search(long companyId,
197         long groupId, long[] folderIds, java.lang.String keywords, int start,
198         int end) throws com.liferay.portal.SystemException;
199 
200     public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
201         long folderId, long parentFolderId, java.lang.String name,
202         java.lang.String description)
203         throws com.liferay.portal.PortalException,
204             com.liferay.portal.SystemException;
205 }