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