1   /**
2    * Copyright (c) 2000-2009 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.kernel.json.JSONArray;
26  import com.liferay.portal.kernel.json.JSONObject;
27  import com.liferay.portal.service.RoleServiceUtil;
28  
29  /**
30   * <a href="RoleServiceJSON.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * ServiceBuilder generated this class. Modifications in this class will be
34   * overwritten the next time is generated.
35   * </p>
36   *
37   * <p>
38   * This class provides a JSON utility for the
39   * <code>com.liferay.portal.service.RoleServiceUtil</code>
40   * service utility. The static methods of this class calls the same methods of
41   * the service utility. However, the signatures are different because it is
42   * difficult 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>,
48   * that is translated to a
49   * <code>com.liferay.portal.kernel.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
52   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
53   * cannot safely use are skipped. The logic for the translation is encapsulated
54   * in <code>com.liferay.portal.service.http.RoleJSONSerializer</code>.
55   * </p>
56   *
57   * <p>
58   * This allows you to call the the backend services directly from JavaScript.
59   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
60   * reference of how that portlet uses the generated JavaScript in
61   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
62   * services directly from JavaScript.
63   * </p>
64   *
65   * <p>
66   * The JSON utility is only generated for remote services.
67   * </p>
68   *
69   * @author Brian Wing Shun Chan
70   *
71   * @see com.liferay.portal.service.RoleServiceUtil
72   * @see com.liferay.portal.service.http.RoleJSONSerializer
73   *
74   */
75  public class RoleServiceJSON {
76      public static JSONObject addRole(java.lang.String name,
77          java.lang.String description, int type)
78          throws com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException {
80          com.liferay.portal.model.Role returnValue = RoleServiceUtil.addRole(name,
81                  description, type);
82  
83          return RoleJSONSerializer.toJSONObject(returnValue);
84      }
85  
86      public static void addUserRoles(long userId, long[] roleIds)
87          throws com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException {
89          RoleServiceUtil.addUserRoles(userId, roleIds);
90      }
91  
92      public static void deleteRole(long roleId)
93          throws com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException {
95          RoleServiceUtil.deleteRole(roleId);
96      }
97  
98      public static JSONObject getGroupRole(long companyId, long groupId)
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException {
101         com.liferay.portal.model.Role returnValue = RoleServiceUtil.getGroupRole(companyId,
102                 groupId);
103 
104         return RoleJSONSerializer.toJSONObject(returnValue);
105     }
106 
107     public static JSONArray getGroupRoles(long groupId)
108         throws com.liferay.portal.SystemException {
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 com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException {
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 com.liferay.portal.PortalException,
124             com.liferay.portal.SystemException {
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 com.liferay.portal.SystemException {
133         java.util.List<com.liferay.portal.model.Role> returnValue = RoleServiceUtil.getUserGroupRoles(userId,
134                 groupId);
135 
136         return RoleJSONSerializer.toJSONArray(returnValue);
137     }
138 
139     public static JSONArray getUserRelatedRoles(long userId,
140         java.util.List<com.liferay.portal.model.Group> groups)
141         throws com.liferay.portal.SystemException {
142         java.util.List<com.liferay.portal.model.Role> returnValue = RoleServiceUtil.getUserRelatedRoles(userId,
143                 groups);
144 
145         return RoleJSONSerializer.toJSONArray(returnValue);
146     }
147 
148     public static JSONArray getUserRoles(long userId)
149         throws com.liferay.portal.SystemException {
150         java.util.List<com.liferay.portal.model.Role> returnValue = RoleServiceUtil.getUserRoles(userId);
151 
152         return RoleJSONSerializer.toJSONArray(returnValue);
153     }
154 
155     public static boolean hasUserRole(long userId, long companyId,
156         java.lang.String name, boolean inherited)
157         throws com.liferay.portal.PortalException,
158             com.liferay.portal.SystemException {
159         boolean returnValue = RoleServiceUtil.hasUserRole(userId, companyId,
160                 name, inherited);
161 
162         return returnValue;
163     }
164 
165     public static boolean hasUserRoles(long userId, long companyId,
166         java.lang.String[] names, boolean inherited)
167         throws com.liferay.portal.PortalException,
168             com.liferay.portal.SystemException {
169         boolean returnValue = RoleServiceUtil.hasUserRoles(userId, companyId,
170                 names, inherited);
171 
172         return returnValue;
173     }
174 
175     public static void unsetUserRoles(long userId, long[] roleIds)
176         throws com.liferay.portal.PortalException,
177             com.liferay.portal.SystemException {
178         RoleServiceUtil.unsetUserRoles(userId, roleIds);
179     }
180 }