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.JSONObject;
28  
29  /**
30   * <a href="DLFolderServiceJSON.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * ServiceBuilder generated this class. Modifications in this class will be
34   * overwritten the next time is generated.
35   * </p>
36   *
37   * <p>
38   * This class provides a JSON utility for the
39   * <code>com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil</code>
40   * service utility. The static methods of this class calls the same methods of
41   * the service utility. However, the signatures are different because it is
42   * difficult for JSON to support certain types.
43   * </p>
44   *
45   * <p>
46   * ServiceBuilder follows certain rules in translating the methods. For example,
47   * if the method in the service utility returns a <code>java.util.List</code>,
48   * that is translated to a <code>org.json.JSONArray</code>. If the method in the
49   * service utility returns a <code>com.liferay.portlet.documentlibrary.model.DLFolder</code>,
50   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
51   * cannot safely use are skipped. The logic for the translation is encapsulated
52   * in <code>com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer</code>.
53   * </p>
54   *
55   * <p>
56   * This allows you to call the the backend services directly from JavaScript.
57   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
58   * reference of how that portlet uses the generated JavaScript in
59   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
60   * services directly from JavaScript.
61   * </p>
62   *
63   * <p>
64   * The JSON utility is only generated for remote services.
65   * </p>
66   *
67   * @author Brian Wing Shun Chan
68   *
69   * @see com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil
70   * @see com.liferay.portlet.documentlibrary.service.http.DLFolderJSONSerializer
71   *
72   */
73  public class DLFolderServiceJSON {
74      public static JSONObject addFolder(long plid, long parentFolderId,
75          java.lang.String name, java.lang.String description,
76          boolean addCommunityPermissions, boolean addGuestPermissions)
77          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
78              com.liferay.portal.PortalException {
79          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(plid,
80                  parentFolderId, name, description, addCommunityPermissions,
81                  addGuestPermissions);
82  
83          return DLFolderJSONSerializer.toJSONObject(returnValue);
84      }
85  
86      public static JSONObject addFolder(long plid, long parentFolderId,
87          java.lang.String name, java.lang.String description,
88          java.lang.String[] communityPermissions,
89          java.lang.String[] guestPermissions)
90          throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
91              com.liferay.portal.PortalException {
92          com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.addFolder(plid,
93                  parentFolderId, name, description, communityPermissions,
94                  guestPermissions);
95  
96          return DLFolderJSONSerializer.toJSONObject(returnValue);
97      }
98  
99      public static JSONObject copyFolder(long plid, long sourceFolderId,
100         long parentFolderId, java.lang.String name,
101         java.lang.String description, boolean addCommunityPermissions,
102         boolean addGuestPermissions)
103         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
104             com.liferay.portal.PortalException {
105         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.copyFolder(plid,
106                 sourceFolderId, parentFolderId, name, description,
107                 addCommunityPermissions, addGuestPermissions);
108 
109         return DLFolderJSONSerializer.toJSONObject(returnValue);
110     }
111 
112     public static void deleteFolder(long folderId)
113         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
114             com.liferay.portal.PortalException {
115         DLFolderServiceUtil.deleteFolder(folderId);
116     }
117 
118     public static void deleteFolder(long groupId, long parentFolderId,
119         java.lang.String name)
120         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
121             com.liferay.portal.PortalException {
122         DLFolderServiceUtil.deleteFolder(groupId, parentFolderId, name);
123     }
124 
125     public static JSONObject getFolder(long folderId)
126         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
127             com.liferay.portal.PortalException {
128         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(folderId);
129 
130         return DLFolderJSONSerializer.toJSONObject(returnValue);
131     }
132 
133     public static JSONObject getFolder(long groupId, long parentFolderId,
134         java.lang.String name)
135         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
136             com.liferay.portal.PortalException {
137         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.getFolder(groupId,
138                 parentFolderId, name);
139 
140         return DLFolderJSONSerializer.toJSONObject(returnValue);
141     }
142 
143     public static long getFolderId(long groupId, long parentFolderId,
144         java.lang.String name)
145         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
146             com.liferay.portal.PortalException {
147         long returnValue = DLFolderServiceUtil.getFolderId(groupId,
148                 parentFolderId, name);
149 
150         return returnValue;
151     }
152 
153     public static void reIndexSearch(long companyId)
154         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
155             com.liferay.portal.PortalException {
156         DLFolderServiceUtil.reIndexSearch(companyId);
157     }
158 
159     public static JSONObject updateFolder(long folderId, long parentFolderId,
160         java.lang.String name, java.lang.String description)
161         throws java.rmi.RemoteException, com.liferay.portal.SystemException, 
162             com.liferay.portal.PortalException {
163         com.liferay.portlet.documentlibrary.model.DLFolder returnValue = DLFolderServiceUtil.updateFolder(folderId,
164                 parentFolderId, name, description);
165 
166         return DLFolderJSONSerializer.toJSONObject(returnValue);
167     }
168 }