1   /**
2    * Copyright (c) 2000-2007 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.portal.service.http;
24  
25  import com.liferay.portal.service.GroupServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="GroupServiceJSON.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be overwritten
35   * the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This class provides a JSON utility for the <code>com.liferay.portal.service.GroupServiceUtil</code>
40   * service utility. The static methods of this class calls the same methods of the
41   * service utility. However, the signatures are different because it is difficult
42   * 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>, that
48   * is translated to a <code>org.json.JSONArray</code>. If the method in the service
49   * utility returns a <code>com.liferay.portal.model.Group</code>, that is translated
50   * to a <code>org.json.JSONObject</code>. Methods that JSON cannot safely use are
51   * skipped. The logic for the translation is encapsulated in <code>com.liferay.portal.service.http.GroupJSONSerializer</code>.
52   * </p>
53   *
54   * <p>
55   * This allows you to call the the backend services directly from JavaScript. See
56   * <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a reference
57   * of how that portlet uses the generated JavaScript in <code>portal-web/docroot/html/js/service.js</code>
58   * to call the backend services directly from JavaScript.
59   * </p>
60   *
61   * <p>
62   * The JSON utility is only generated for remote services.
63   * </p>
64   *
65   * @author Brian Wing Shun Chan
66   *
67   * @see com.liferay.portal.service.GroupServiceUtil
68   * @see com.liferay.portal.service.http.GroupJSONSerializer
69   *
70   */
71  public class GroupServiceJSON {
72      public static JSONObject addGroup(java.lang.String name,
73          java.lang.String description, java.lang.String type,
74          java.lang.String friendlyURL, boolean active)
75          throws com.liferay.portal.SystemException, 
76              com.liferay.portal.PortalException, java.rmi.RemoteException {
77          com.liferay.portal.model.Group returnValue = GroupServiceUtil.addGroup(name,
78                  description, type, friendlyURL, active);
79  
80          return GroupJSONSerializer.toJSONObject(returnValue);
81      }
82  
83      public static JSONObject addGroup(long liveGroupId, java.lang.String name,
84          java.lang.String description, java.lang.String type,
85          java.lang.String friendlyURL, boolean active)
86          throws com.liferay.portal.SystemException, 
87              com.liferay.portal.PortalException, java.rmi.RemoteException {
88          com.liferay.portal.model.Group returnValue = GroupServiceUtil.addGroup(liveGroupId,
89                  name, description, type, friendlyURL, active);
90  
91          return GroupJSONSerializer.toJSONObject(returnValue);
92      }
93  
94      public static void addRoleGroups(long roleId, long[] groupIds)
95          throws com.liferay.portal.SystemException, 
96              com.liferay.portal.PortalException, java.rmi.RemoteException {
97          GroupServiceUtil.addRoleGroups(roleId, groupIds);
98      }
99  
100     public static void deleteGroup(long groupId)
101         throws com.liferay.portal.SystemException, 
102             com.liferay.portal.PortalException, java.rmi.RemoteException {
103         GroupServiceUtil.deleteGroup(groupId);
104     }
105 
106     public static JSONObject getGroup(long groupId)
107         throws com.liferay.portal.SystemException, 
108             com.liferay.portal.PortalException, java.rmi.RemoteException {
109         com.liferay.portal.model.Group returnValue = GroupServiceUtil.getGroup(groupId);
110 
111         return GroupJSONSerializer.toJSONObject(returnValue);
112     }
113 
114     public static JSONObject getGroup(long companyId, java.lang.String name)
115         throws com.liferay.portal.SystemException, 
116             com.liferay.portal.PortalException, java.rmi.RemoteException {
117         com.liferay.portal.model.Group returnValue = GroupServiceUtil.getGroup(companyId,
118                 name);
119 
120         return GroupJSONSerializer.toJSONObject(returnValue);
121     }
122 
123     public static JSONArray getOrganizationsGroups(java.util.List organizations)
124         throws com.liferay.portal.SystemException, 
125             com.liferay.portal.PortalException, java.rmi.RemoteException {
126         java.util.List returnValue = GroupServiceUtil.getOrganizationsGroups(organizations);
127 
128         return GroupJSONSerializer.toJSONArray(returnValue);
129     }
130 
131     public static JSONArray getUserGroupsGroups(java.util.List userGroups)
132         throws com.liferay.portal.SystemException, 
133             com.liferay.portal.PortalException, java.rmi.RemoteException {
134         java.util.List returnValue = GroupServiceUtil.getUserGroupsGroups(userGroups);
135 
136         return GroupJSONSerializer.toJSONArray(returnValue);
137     }
138 
139     public static boolean hasUserGroup(long userId, long groupId)
140         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
141         boolean returnValue = GroupServiceUtil.hasUserGroup(userId, groupId);
142 
143         return returnValue;
144     }
145 
146     public static JSONArray search(long companyId, java.lang.String name,
147         java.lang.String description, java.lang.String[] params, int begin,
148         int end)
149         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
150         java.util.List returnValue = GroupServiceUtil.search(companyId, name,
151                 description, params, begin, end);
152 
153         return GroupJSONSerializer.toJSONArray(returnValue);
154     }
155 
156     public static int searchCount(long companyId, java.lang.String name,
157         java.lang.String description, java.lang.String[] params)
158         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
159         int returnValue = GroupServiceUtil.searchCount(companyId, name,
160                 description, params);
161 
162         return returnValue;
163     }
164 
165     public static void setRoleGroups(long roleId, long[] groupIds)
166         throws com.liferay.portal.SystemException, 
167             com.liferay.portal.PortalException, java.rmi.RemoteException {
168         GroupServiceUtil.setRoleGroups(roleId, groupIds);
169     }
170 
171     public static void unsetRoleGroups(long roleId, long[] groupIds)
172         throws com.liferay.portal.SystemException, 
173             com.liferay.portal.PortalException, java.rmi.RemoteException {
174         GroupServiceUtil.unsetRoleGroups(roleId, groupIds);
175     }
176 
177     public static JSONObject updateGroup(long groupId, java.lang.String name,
178         java.lang.String description, java.lang.String type,
179         java.lang.String friendlyURL, boolean active)
180         throws com.liferay.portal.SystemException, 
181             com.liferay.portal.PortalException, java.rmi.RemoteException {
182         com.liferay.portal.model.Group returnValue = GroupServiceUtil.updateGroup(groupId,
183                 name, description, type, friendlyURL, active);
184 
185         return GroupJSONSerializer.toJSONObject(returnValue);
186     }
187 
188     public static JSONObject updateGroup(long groupId,
189         java.lang.String typeSettings)
190         throws com.liferay.portal.SystemException, 
191             com.liferay.portal.PortalException, java.rmi.RemoteException {
192         com.liferay.portal.model.Group returnValue = GroupServiceUtil.updateGroup(groupId,
193                 typeSettings);
194 
195         return GroupJSONSerializer.toJSONObject(returnValue);
196     }
197 }