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.UserGroupServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="UserGroupServiceJSON.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.UserGroupServiceUtil</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.UserGroup</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.UserGroupJSONSerializer</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.UserGroupServiceUtil
68   * @see com.liferay.portal.service.http.UserGroupJSONSerializer
69   *
70   */
71  public class UserGroupServiceJSON {
72      public static void addGroupUserGroups(long groupId, long[] userGroupIds)
73          throws com.liferay.portal.SystemException, 
74              com.liferay.portal.PortalException, java.rmi.RemoteException {
75          UserGroupServiceUtil.addGroupUserGroups(groupId, userGroupIds);
76      }
77  
78      public static JSONObject addUserGroup(java.lang.String name,
79          java.lang.String description)
80          throws com.liferay.portal.SystemException, 
81              com.liferay.portal.PortalException, java.rmi.RemoteException {
82          com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.addUserGroup(name,
83                  description);
84  
85          return UserGroupJSONSerializer.toJSONObject(returnValue);
86      }
87  
88      public static void deleteUserGroup(long userGroupId)
89          throws com.liferay.portal.SystemException, 
90              com.liferay.portal.PortalException, java.rmi.RemoteException {
91          UserGroupServiceUtil.deleteUserGroup(userGroupId);
92      }
93  
94      public static JSONObject getUserGroup(long userGroupId)
95          throws com.liferay.portal.SystemException, 
96              com.liferay.portal.PortalException, java.rmi.RemoteException {
97          com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.getUserGroup(userGroupId);
98  
99          return UserGroupJSONSerializer.toJSONObject(returnValue);
100     }
101 
102     public static JSONObject getUserGroup(java.lang.String name)
103         throws com.liferay.portal.SystemException, 
104             com.liferay.portal.PortalException, java.rmi.RemoteException {
105         com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.getUserGroup(name);
106 
107         return UserGroupJSONSerializer.toJSONObject(returnValue);
108     }
109 
110     public static JSONArray getUserUserGroups(long userId)
111         throws com.liferay.portal.SystemException, 
112             com.liferay.portal.PortalException, java.rmi.RemoteException {
113         java.util.List returnValue = UserGroupServiceUtil.getUserUserGroups(userId);
114 
115         return UserGroupJSONSerializer.toJSONArray(returnValue);
116     }
117 
118     public static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
119         throws com.liferay.portal.SystemException, 
120             com.liferay.portal.PortalException, java.rmi.RemoteException {
121         UserGroupServiceUtil.unsetGroupUserGroups(groupId, userGroupIds);
122     }
123 
124     public static JSONObject updateUserGroup(long userGroupId,
125         java.lang.String name, java.lang.String description)
126         throws com.liferay.portal.SystemException, 
127             com.liferay.portal.PortalException, java.rmi.RemoteException {
128         com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.updateUserGroup(userGroupId,
129                 name, description);
130 
131         return UserGroupJSONSerializer.toJSONObject(returnValue);
132     }
133 }