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.http;
24  
25  import com.liferay.portal.kernel.json.JSONArray;
26  import com.liferay.portal.kernel.json.JSONObject;
27  
28  import com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil;
29  
30  /**
31   * <a href="DLFolderServiceJSON.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 class provides a JSON utility for the
40   * <code>com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil</code>
41   * service utility. The static methods of this class calls the same methods of
42   * the service utility. However, the signatures are different because it is
43   * difficult for JSON to support certain types.
44   * </p>
45   *
46   * <p>
47   * ServiceBuilder follows certain rules in translating the methods. For example,
48   * if the method in the service utility returns a <code>java.util.List</code>,
49   * that is translated to a
50   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
51   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFolder</code>,
52   * that is translated to a
53   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
54   * cannot safely use are skipped. The logic for the translation is encapsulated
55   * in <code>com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer</code>.
56   * </p>
57   *
58   * <p>
59   * This allows you to call the the backend services directly from JavaScript.
60   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
61   * reference of how that portlet uses the generated JavaScript in
62   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
63   * services directly from JavaScript.
64   * </p>
65   *
66   * <p>
67   * The JSON utility is only generated for remote services.
68   * </p>
69   *
70   * @author Brian Wing Shun Chan
71   *
72   * @see com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil
73   * @see com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer
74   *
75   */
76  public class DLFolderServiceJSON {
77      public static JSONObject addFolder(long groupId, long parentFolderId,
78          java.lang.String name, java.lang.String description,
79          boolean addCommunityPermissions, boolean addGuestPermissions)
80          throws com.liferay.portal.PortalException,
81              com.liferay.portal.SystemException {
82          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(groupId,
83                  parentFolderId, name, description, addCommunityPermissions,
84                  addGuestPermissions);
85  
86          return DLFolderJSONSerializer.toJSONObject(returnValue);
87      }
88  
89      public static JSONObject addFolder(long groupId, long parentFolderId,
90          java.lang.String name, java.lang.String description,
91          java.lang.String[] communityPermissions,
92          java.lang.String[] guestPermissions)
93          throws com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException {
95          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(groupId,
96                  parentFolderId, name, description, communityPermissions,
97                  guestPermissions);
98  
99          return DLFolderJSONSerializer.toJSONObject(returnValue);
100     }
101 
102     public static JSONObject copyFolder(long groupId, long sourceFolderId,
103         long parentFolderId, java.lang.String name,
104         java.lang.String description, boolean addCommunityPermissions,
105         boolean addGuestPermissions)
106         throws com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException, java.rmi.RemoteException {
108         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.copyFolder(groupId,
109                 sourceFolderId, parentFolderId, name, description,
110                 addCommunityPermissions, addGuestPermissions);
111 
112         return DLFolderJSONSerializer.toJSONObject(returnValue);
113     }
114 
115     public static void deleteFolder(long folderId)
116         throws com.liferay.portal.PortalException,
117             com.liferay.portal.SystemException, java.rmi.RemoteException {
118         DLFolderServiceUtil.deleteFolder(folderId);
119     }
120 
121     public static void deleteFolder(long groupId, long parentFolderId,
122         java.lang.String name)
123         throws com.liferay.portal.PortalException,
124             com.liferay.portal.SystemException, java.rmi.RemoteException {
125         DLFolderServiceUtil.deleteFolder(groupId, parentFolderId, name);
126     }
127 
128     public static JSONObject getFolder(long folderId)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException {
131         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(folderId);
132 
133         return DLFolderJSONSerializer.toJSONObject(returnValue);
134     }
135 
136     public static JSONObject getFolder(long groupId, long parentFolderId,
137         java.lang.String name)
138         throws com.liferay.portal.PortalException,
139             com.liferay.portal.SystemException {
140         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(groupId,
141                 parentFolderId, name);
142 
143         return DLFolderJSONSerializer.toJSONObject(returnValue);
144     }
145 
146     public static long getFolderId(long groupId, long parentFolderId,
147         java.lang.String name)
148         throws com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException {
150         long returnValue = DLFolderServiceUtil.getFolderId(groupId,
151                 parentFolderId, name);
152 
153         return returnValue;
154     }
155 
156     public static JSONArray getFolders(long groupId, long parentFolderId)
157         throws com.liferay.portal.PortalException,
158             com.liferay.portal.SystemException {
159         java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> returnValue =
160             DLFolderServiceUtil.getFolders(groupId, parentFolderId);
161 
162         return DLFolderJSONSerializer.toJSONArray(returnValue);
163     }
164 
165     public static boolean hasInheritableLock(long folderId)
166         throws com.liferay.portal.PortalException {
167         boolean returnValue = DLFolderServiceUtil.hasInheritableLock(folderId);
168 
169         return returnValue;
170     }
171 
172     public static com.liferay.lock.model.Lock lockFolder(long folderId)
173         throws com.liferay.portal.PortalException,
174             com.liferay.portal.SystemException, java.rmi.RemoteException {
175         com.liferay.lock.model.Lock returnValue = DLFolderServiceUtil.lockFolder(folderId);
176 
177         return returnValue;
178     }
179 
180     public static com.liferay.lock.model.Lock lockFolder(long folderId,
181         java.lang.String owner, boolean inheritable, long expirationTime)
182         throws com.liferay.portal.PortalException,
183             com.liferay.portal.SystemException, java.rmi.RemoteException {
184         com.liferay.lock.model.Lock returnValue = DLFolderServiceUtil.lockFolder(folderId,
185                 owner, inheritable, expirationTime);
186 
187         return returnValue;
188     }
189 
190     public static com.liferay.lock.model.Lock refreshFolderLock(
191         java.lang.String lockUuid, long expirationTime)
192         throws com.liferay.portal.PortalException {
193         com.liferay.lock.model.Lock returnValue = DLFolderServiceUtil.refreshFolderLock(lockUuid,
194                 expirationTime);
195 
196         return returnValue;
197     }
198 
199     public static void reIndexSearch(long companyId)
200         throws com.liferay.portal.PortalException,
201             com.liferay.portal.SystemException {
202         DLFolderServiceUtil.reIndexSearch(companyId);
203     }
204 
205     public static void unlockFolder(long folderId, java.lang.String lockUuid)
206         throws com.liferay.portal.PortalException {
207         DLFolderServiceUtil.unlockFolder(folderId, lockUuid);
208     }
209 
210     public static void unlockFolder(long groupId, long parentFolderId,
211         java.lang.String name, java.lang.String lockUuid)
212         throws com.liferay.portal.PortalException,
213             com.liferay.portal.SystemException {
214         DLFolderServiceUtil.unlockFolder(groupId, parentFolderId, name, lockUuid);
215     }
216 
217     public static JSONObject updateFolder(long folderId, long parentFolderId,
218         java.lang.String name, java.lang.String description)
219         throws com.liferay.portal.PortalException,
220             com.liferay.portal.SystemException, java.rmi.RemoteException {
221         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.updateFolder(folderId,
222                 parentFolderId, name, description);
223 
224         return DLFolderJSONSerializer.toJSONObject(returnValue);
225     }
226 
227     public static boolean verifyInheritableLock(long folderId,
228         java.lang.String lockUuid) throws com.liferay.portal.PortalException {
229         boolean returnValue = DLFolderServiceUtil.verifyInheritableLock(folderId,
230                 lockUuid);
231 
232         return returnValue;
233     }
234 }