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