| UserGroupServiceJSON.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * The contents of this file are subject to the terms of the Liferay Enterprise
5 * Subscription License ("License"). You may not use this file except in
6 * compliance with the License. You can obtain a copy of the License by
7 * contacting Liferay, Inc. See the License for the specific language governing
8 * permissions and limitations under the License, including but not limited to
9 * distribution rights of the Software.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17 * SOFTWARE.
18 */
19
20 package com.liferay.portal.service.http;
21
22 import com.liferay.portal.kernel.json.JSONArray;
23 import com.liferay.portal.kernel.json.JSONObject;
24 import com.liferay.portal.service.UserGroupServiceUtil;
25
26 /**
27 * <a href="UserGroupServiceJSON.java.html"><b><i>View Source</i></b></a>
28 *
29 * <p>
30 * ServiceBuilder generated this class. Modifications in this class will be
31 * overwritten the next time is generated.
32 * </p>
33 *
34 * <p>
35 * This class provides a JSON utility for the
36 * <code>com.liferay.portal.service.UserGroupServiceUtil</code>
37 * service utility. The static methods of this class calls the same methods of
38 * the service utility. However, the signatures are different because it is
39 * difficult for JSON to support certain types.
40 * </p>
41 *
42 * <p>
43 * ServiceBuilder follows certain rules in translating the methods. For example,
44 * if the method in the service utility returns a <code>java.util.List</code>,
45 * that is translated to a
46 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
47 * service utility returns a <code>com.liferay.portal.model.UserGroup</code>,
48 * that is translated to a
49 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
50 * cannot safely use are skipped. The logic for the translation is encapsulated
51 * 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.
56 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
57 * reference of how that portlet uses the generated JavaScript in
58 * <code>portal-web/docroot/html/js/service.js</code> to call the backend
59 * services directly from JavaScript.
60 * </p>
61 *
62 * <p>
63 * The JSON utility is only generated for remote services.
64 * </p>
65 *
66 * @author Brian Wing Shun Chan
67 *
68 * @see com.liferay.portal.service.UserGroupServiceUtil
69 * @see com.liferay.portal.service.http.UserGroupJSONSerializer
70 *
71 */
72 public class UserGroupServiceJSON {
73 public static void addGroupUserGroups(long groupId, long[] userGroupIds)
74 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
75 com.liferay.portal.SystemException {
76 UserGroupServiceUtil.addGroupUserGroups(groupId, userGroupIds);
77 }
78
79 public static JSONObject addUserGroup(java.lang.String name,
80 java.lang.String description)
81 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
82 com.liferay.portal.SystemException {
83 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.addUserGroup(name,
84 description);
85
86 return UserGroupJSONSerializer.toJSONObject(returnValue);
87 }
88
89 public static void deleteUserGroup(long userGroupId)
90 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
91 com.liferay.portal.SystemException {
92 UserGroupServiceUtil.deleteUserGroup(userGroupId);
93 }
94
95 public static JSONObject getUserGroup(long userGroupId)
96 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
97 com.liferay.portal.SystemException {
98 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.getUserGroup(userGroupId);
99
100 return UserGroupJSONSerializer.toJSONObject(returnValue);
101 }
102
103 public static JSONObject getUserGroup(java.lang.String name)
104 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
105 com.liferay.portal.SystemException {
106 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.getUserGroup(name);
107
108 return UserGroupJSONSerializer.toJSONObject(returnValue);
109 }
110
111 public static JSONArray getUserUserGroups(long userId)
112 throws java.rmi.RemoteException, com.liferay.portal.SystemException {
113 java.util.List<com.liferay.portal.model.UserGroup> returnValue = UserGroupServiceUtil.getUserUserGroups(userId);
114
115 return UserGroupJSONSerializer.toJSONArray(returnValue);
116 }
117
118 public static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
119 throws java.rmi.RemoteException, com.liferay.portal.PortalException,
120 com.liferay.portal.SystemException {
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 java.rmi.RemoteException, com.liferay.portal.PortalException,
127 com.liferay.portal.SystemException {
128 com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil.updateUserGroup(userGroupId,
129 name, description);
130
131 return UserGroupJSONSerializer.toJSONObject(returnValue);
132 }
133 }