001: /**
002: * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
003: *
004: * Permission is hereby granted, free of charge, to any person obtaining a copy
005: * of this software and associated documentation files (the "Software"), to deal
006: * in the Software without restriction, including without limitation the rights
007: * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008: * copies of the Software, and to permit persons to whom the Software is
009: * furnished to do so, subject to the following conditions:
010: *
011: * The above copyright notice and this permission notice shall be included in
012: * all copies or substantial portions of the Software.
013: *
014: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017: * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019: * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
020: * SOFTWARE.
021: */package com.liferay.portal.service.http;
022:
023: import com.liferay.portal.service.UserGroupServiceUtil;
024:
025: import org.json.JSONArray;
026: import org.json.JSONObject;
027:
028: /**
029: * <a href="UserGroupServiceJSON.java.html"><b><i>View Source</i></b></a>
030: *
031: * <p>
032: * ServiceBuilder generated this class. Modifications in this class will be
033: * overwritten the next time is generated.
034: * </p>
035: *
036: * <p>
037: * This class provides a JSON utility for the
038: * <code>com.liferay.portal.service.UserGroupServiceUtil</code>
039: * service utility. The static methods of this class calls the same methods of
040: * the service utility. However, the signatures are different because it is
041: * difficult for JSON to support certain types.
042: * </p>
043: *
044: * <p>
045: * ServiceBuilder follows certain rules in translating the methods. For example,
046: * if the method in the service utility returns a <code>java.util.List</code>,
047: * that is translated to a <code>org.json.JSONArray</code>. If the method in the
048: * service utility returns a <code>com.liferay.portal.model.UserGroup</code>,
049: * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON
050: * cannot safely use are skipped. The logic for the translation is encapsulated
051: * in <code>com.liferay.portal.service.http.UserGroupJSONSerializer</code>.
052: * </p>
053: *
054: * <p>
055: * This allows you to call the the backend services directly from JavaScript.
056: * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
057: * reference of how that portlet uses the generated JavaScript in
058: * <code>portal-web/docroot/html/js/service.js</code> to call the backend
059: * services directly from JavaScript.
060: * </p>
061: *
062: * <p>
063: * The JSON utility is only generated for remote services.
064: * </p>
065: *
066: * @author Brian Wing Shun Chan
067: *
068: * @see com.liferay.portal.service.UserGroupServiceUtil
069: * @see com.liferay.portal.service.http.UserGroupJSONSerializer
070: *
071: */
072: public class UserGroupServiceJSON {
073: public static void addGroupUserGroups(long groupId,
074: long[] userGroupIds) throws java.rmi.RemoteException,
075: com.liferay.portal.SystemException,
076: com.liferay.portal.PortalException {
077: UserGroupServiceUtil.addGroupUserGroups(groupId, userGroupIds);
078: }
079:
080: public static JSONObject addUserGroup(java.lang.String name,
081: java.lang.String description)
082: throws java.rmi.RemoteException,
083: com.liferay.portal.SystemException,
084: com.liferay.portal.PortalException {
085: com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil
086: .addUserGroup(name, description);
087:
088: return UserGroupJSONSerializer.toJSONObject(returnValue);
089: }
090:
091: public static void deleteUserGroup(long userGroupId)
092: throws java.rmi.RemoteException,
093: com.liferay.portal.SystemException,
094: com.liferay.portal.PortalException {
095: UserGroupServiceUtil.deleteUserGroup(userGroupId);
096: }
097:
098: public static JSONObject getUserGroup(long userGroupId)
099: throws java.rmi.RemoteException,
100: com.liferay.portal.SystemException,
101: com.liferay.portal.PortalException {
102: com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil
103: .getUserGroup(userGroupId);
104:
105: return UserGroupJSONSerializer.toJSONObject(returnValue);
106: }
107:
108: public static JSONObject getUserGroup(java.lang.String name)
109: throws java.rmi.RemoteException,
110: com.liferay.portal.SystemException,
111: com.liferay.portal.PortalException {
112: com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil
113: .getUserGroup(name);
114:
115: return UserGroupJSONSerializer.toJSONObject(returnValue);
116: }
117:
118: public static JSONArray getUserUserGroups(long userId)
119: throws java.rmi.RemoteException,
120: com.liferay.portal.SystemException,
121: com.liferay.portal.PortalException {
122: java.util.List returnValue = UserGroupServiceUtil
123: .getUserUserGroups(userId);
124:
125: return UserGroupJSONSerializer.toJSONArray(returnValue);
126: }
127:
128: public static void unsetGroupUserGroups(long groupId,
129: long[] userGroupIds) throws java.rmi.RemoteException,
130: com.liferay.portal.SystemException,
131: com.liferay.portal.PortalException {
132: UserGroupServiceUtil
133: .unsetGroupUserGroups(groupId, userGroupIds);
134: }
135:
136: public static JSONObject updateUserGroup(long userGroupId,
137: java.lang.String name, java.lang.String description)
138: throws java.rmi.RemoteException,
139: com.liferay.portal.SystemException,
140: com.liferay.portal.PortalException {
141: com.liferay.portal.model.UserGroup returnValue = UserGroupServiceUtil
142: .updateUserGroup(userGroupId, name, description);
143:
144: return UserGroupJSONSerializer.toJSONObject(returnValue);
145: }
146: }
|