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