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.RoleServiceUtil;
26  
27  import org.json.JSONArray;
28  import org.json.JSONObject;
29  
30  /**
31   * <a href="RoleServiceJSON.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.RoleServiceUtil</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.Role</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.RoleJSONSerializer</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.RoleServiceUtil
68   * @see com.liferay.portal.service.http.RoleJSONSerializer
69   *
70   */
71  public class RoleServiceJSON {
72      public static JSONObject addRole(java.lang.String name, int type)
73          throws com.liferay.portal.SystemException, 
74              com.liferay.portal.PortalException, java.rmi.RemoteException {
75          com.liferay.portal.model.Role returnValue = RoleServiceUtil.addRole(name,
76                  type);
77  
78          return RoleJSONSerializer.toJSONObject(returnValue);
79      }
80  
81      public static void deleteRole(long roleId)
82          throws com.liferay.portal.SystemException, 
83              com.liferay.portal.PortalException, java.rmi.RemoteException {
84          RoleServiceUtil.deleteRole(roleId);
85      }
86  
87      public static JSONObject getGroupRole(long companyId, long groupId)
88          throws com.liferay.portal.SystemException, 
89              com.liferay.portal.PortalException, java.rmi.RemoteException {
90          com.liferay.portal.model.Role returnValue = RoleServiceUtil.getGroupRole(companyId,
91                  groupId);
92  
93          return RoleJSONSerializer.toJSONObject(returnValue);
94      }
95  
96      public static JSONArray getGroupRoles(long groupId)
97          throws com.liferay.portal.SystemException, 
98              com.liferay.portal.PortalException, java.rmi.RemoteException {
99          java.util.List returnValue = RoleServiceUtil.getGroupRoles(groupId);
100 
101         return RoleJSONSerializer.toJSONArray(returnValue);
102     }
103 
104     public static JSONObject getRole(long roleId)
105         throws com.liferay.portal.SystemException, 
106             com.liferay.portal.PortalException, java.rmi.RemoteException {
107         com.liferay.portal.model.Role returnValue = RoleServiceUtil.getRole(roleId);
108 
109         return RoleJSONSerializer.toJSONObject(returnValue);
110     }
111 
112     public static JSONObject getRole(long companyId, java.lang.String name)
113         throws com.liferay.portal.SystemException, 
114             com.liferay.portal.PortalException, java.rmi.RemoteException {
115         com.liferay.portal.model.Role returnValue = RoleServiceUtil.getRole(companyId,
116                 name);
117 
118         return RoleJSONSerializer.toJSONObject(returnValue);
119     }
120 
121     public static JSONArray getUserGroupRoles(long userId, long groupId)
122         throws com.liferay.portal.SystemException, 
123             com.liferay.portal.PortalException, java.rmi.RemoteException {
124         java.util.List returnValue = RoleServiceUtil.getUserGroupRoles(userId,
125                 groupId);
126 
127         return RoleJSONSerializer.toJSONArray(returnValue);
128     }
129 
130     public static JSONArray getUserRelatedRoles(long userId,
131         java.util.List groups)
132         throws com.liferay.portal.SystemException, 
133             com.liferay.portal.PortalException, java.rmi.RemoteException {
134         java.util.List returnValue = RoleServiceUtil.getUserRelatedRoles(userId,
135                 groups);
136 
137         return RoleJSONSerializer.toJSONArray(returnValue);
138     }
139 
140     public static JSONArray getUserRoles(long userId)
141         throws com.liferay.portal.SystemException, 
142             com.liferay.portal.PortalException, java.rmi.RemoteException {
143         java.util.List returnValue = RoleServiceUtil.getUserRoles(userId);
144 
145         return RoleJSONSerializer.toJSONArray(returnValue);
146     }
147 
148     public static boolean hasUserRole(long userId, long companyId,
149         java.lang.String name, boolean inherited)
150         throws com.liferay.portal.SystemException, 
151             com.liferay.portal.PortalException, java.rmi.RemoteException {
152         boolean returnValue = RoleServiceUtil.hasUserRole(userId, companyId,
153                 name, inherited);
154 
155         return returnValue;
156     }
157 
158     public static boolean hasUserRoles(long userId, long companyId,
159         java.lang.String[] names, boolean inherited)
160         throws com.liferay.portal.SystemException, 
161             com.liferay.portal.PortalException, java.rmi.RemoteException {
162         boolean returnValue = RoleServiceUtil.hasUserRoles(userId, companyId,
163                 names, inherited);
164 
165         return returnValue;
166     }
167 
168     public static JSONObject updateRole(long roleId, java.lang.String name)
169         throws com.liferay.portal.SystemException, 
170             com.liferay.portal.PortalException, java.rmi.RemoteException {
171         com.liferay.portal.model.Role returnValue = RoleServiceUtil.updateRole(roleId,
172                 name);
173 
174         return RoleJSONSerializer.toJSONObject(returnValue);
175     }
176 }