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.http;
24  
25  import com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
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 <code>org.json.JSONArray</code>. If the method in the
50   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFolder</code>,
51   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
52   * cannot safely use are skipped. The logic for the translation is encapsulated
53   * in <code>com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer</code>.
54   * </p>
55   *
56   * <p>
57   * This allows you to call the the backend services directly from JavaScript.
58   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
59   * reference of how that portlet uses the generated JavaScript in
60   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
61   * services directly from JavaScript.
62   * </p>
63   *
64   * <p>
65   * The JSON utility is only generated for remote services.
66   * </p>
67   *
68   * @author Brian Wing Shun Chan
69   *
70   * @see com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil
71   * @see com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer
72   *
73   */
74  public class DLFolderServiceJSON {
75      public static JSONObject addFolder(long plid, long parentFolderId,
76          java.lang.String name, java.lang.String description,
77          boolean addCommunityPermissions, boolean addGuestPermissions)
78          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException {
80          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(plid,
81                  parentFolderId, name, description, addCommunityPermissions,
82                  addGuestPermissions);
83  
84          return DLFolderJSONSerializer.toJSONObject(returnValue);
85      }
86  
87      public static JSONObject addFolder(long plid, long parentFolderId,
88          java.lang.String name, java.lang.String description,
89          java.lang.String[] communityPermissions,
90          java.lang.String[] guestPermissions)
91          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
92              com.liferay.portal.PortalException {
93          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(plid,
94                  parentFolderId, name, description, communityPermissions,
95                  guestPermissions);
96  
97          return DLFolderJSONSerializer.toJSONObject(returnValue);
98      }
99  
100     public static JSONObject copyFolder(long plid, long sourceFolderId,
101         long parentFolderId, java.lang.String name,
102         java.lang.String description, boolean addCommunityPermissions,
103         boolean addGuestPermissions)
104         throws com.liferay.portal.SystemException,
105             com.liferay.portal.PortalException, java.rmi.RemoteException {
106         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.copyFolder(plid,
107                 sourceFolderId, parentFolderId, name, description,
108                 addCommunityPermissions, addGuestPermissions);
109 
110         return DLFolderJSONSerializer.toJSONObject(returnValue);
111     }
112 
113     public static void deleteFolder(long folderId)
114         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
115             com.liferay.portal.PortalException {
116         DLFolderServiceUtil.deleteFolder(folderId);
117     }
118 
119     public static void deleteFolder(long groupId, long parentFolderId,
120         java.lang.String name)
121         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
122             com.liferay.portal.PortalException {
123         DLFolderServiceUtil.deleteFolder(groupId, parentFolderId, name);
124     }
125 
126     public static JSONObject getFolder(long folderId)
127         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
128             com.liferay.portal.PortalException {
129         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(folderId);
130 
131         return DLFolderJSONSerializer.toJSONObject(returnValue);
132     }
133 
134     public static JSONObject getFolder(long groupId, long parentFolderId,
135         java.lang.String name)
136         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
137             com.liferay.portal.PortalException {
138         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(groupId,
139                 parentFolderId, name);
140 
141         return DLFolderJSONSerializer.toJSONObject(returnValue);
142     }
143 
144     public static long getFolderId(long groupId, long parentFolderId,
145         java.lang.String name)
146         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
147             com.liferay.portal.PortalException {
148         long returnValue = DLFolderServiceUtil.getFolderId(groupId,
149                 parentFolderId, name);
150 
151         return returnValue;
152     }
153 
154     public static JSONArray getFolders(long groupId, long parentFolderId)
155         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
156             com.liferay.portal.PortalException {
157         java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> returnValue =
158             DLFolderServiceUtil.getFolders(groupId, parentFolderId);
159 
160         return DLFolderJSONSerializer.toJSONArray(returnValue);
161     }
162 
163     public static void reIndexSearch(long companyId)
164         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
165             com.liferay.portal.PortalException {
166         DLFolderServiceUtil.reIndexSearch(companyId);
167     }
168 
169     public static JSONObject updateFolder(long folderId, long parentFolderId,
170         java.lang.String name, java.lang.String description)
171         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
172             com.liferay.portal.PortalException {
173         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.updateFolder(folderId,
174                 parentFolderId, name, description);
175 
176         return DLFolderJSONSerializer.toJSONObject(returnValue);
177     }
178 }