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.GroupServiceUtil;
28  
29  /**
30   * <a href="GroupServiceJSON.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.GroupServiceUtil</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.Group</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.GroupJSONSerializer</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.GroupServiceUtil
72   * @see com.liferay.portal.service.http.GroupJSONSerializer
73   *
74   */
75  public class GroupServiceJSON {
76      public static JSONObject addGroup(java.lang.String name,
77          java.lang.String description, int type, java.lang.String friendlyURL,
78          boolean active)
79          throws com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException {
81          com.liferay.portal.model.Group returnValue = GroupServiceUtil.addGroup(name,
82                  description, type, friendlyURL, active);
83  
84          return GroupJSONSerializer.toJSONObject(returnValue);
85      }
86  
87      public static JSONObject addGroup(long liveGroupId, java.lang.String name,
88          java.lang.String description, int type, java.lang.String friendlyURL,
89          boolean active)
90          throws com.liferay.portal.PortalException,
91              com.liferay.portal.SystemException {
92          com.liferay.portal.model.Group returnValue = GroupServiceUtil.addGroup(liveGroupId,
93                  name, description, type, friendlyURL, active);
94  
95          return GroupJSONSerializer.toJSONObject(returnValue);
96      }
97  
98      public static void addRoleGroups(long roleId, long[] groupIds)
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException {
101         GroupServiceUtil.addRoleGroups(roleId, groupIds);
102     }
103 
104     public static void deleteGroup(long groupId)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException {
107         GroupServiceUtil.deleteGroup(groupId);
108     }
109 
110     public static JSONObject getGroup(long groupId)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException {
113         com.liferay.portal.model.Group returnValue = GroupServiceUtil.getGroup(groupId);
114 
115         return GroupJSONSerializer.toJSONObject(returnValue);
116     }
117 
118     public static JSONObject getGroup(long companyId, java.lang.String name)
119         throws com.liferay.portal.PortalException,
120             com.liferay.portal.SystemException {
121         com.liferay.portal.model.Group returnValue = GroupServiceUtil.getGroup(companyId,
122                 name);
123 
124         return GroupJSONSerializer.toJSONObject(returnValue);
125     }
126 
127     public static JSONArray getManageableGroups(long userId,
128         java.lang.String actionId)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException {
131         java.util.List<com.liferay.portal.model.Group> returnValue = GroupServiceUtil.getManageableGroups(userId,
132                 actionId);
133 
134         return GroupJSONSerializer.toJSONArray(returnValue);
135     }
136 
137     public static JSONArray getOrganizationsGroups(
138         java.util.List<com.liferay.portal.model.Organization> organizations) {
139         java.util.List<com.liferay.portal.model.Group> returnValue = GroupServiceUtil.getOrganizationsGroups(organizations);
140 
141         return GroupJSONSerializer.toJSONArray(returnValue);
142     }
143 
144     public static JSONObject getUserGroup(long companyId, long userId)
145         throws com.liferay.portal.PortalException,
146             com.liferay.portal.SystemException {
147         com.liferay.portal.model.Group returnValue = GroupServiceUtil.getUserGroup(companyId,
148                 userId);
149 
150         return GroupJSONSerializer.toJSONObject(returnValue);
151     }
152 
153     public static JSONArray getUserGroupsGroups(
154         java.util.List<com.liferay.portal.model.UserGroup> userGroups) {
155         java.util.List<com.liferay.portal.model.Group> returnValue = GroupServiceUtil.getUserGroupsGroups(userGroups);
156 
157         return GroupJSONSerializer.toJSONArray(returnValue);
158     }
159 
160     public static JSONArray getUserOrganizationsGroups(long userId, int start,
161         int end)
162         throws com.liferay.portal.PortalException,
163             com.liferay.portal.SystemException {
164         java.util.List<com.liferay.portal.model.Group> returnValue = GroupServiceUtil.getUserOrganizationsGroups(userId,
165                 start, end);
166 
167         return GroupJSONSerializer.toJSONArray(returnValue);
168     }
169 
170     public static boolean hasUserGroup(long userId, long groupId)
171         throws com.liferay.portal.SystemException {
172         boolean returnValue = GroupServiceUtil.hasUserGroup(userId, groupId);
173 
174         return returnValue;
175     }
176 
177     public static JSONArray search(long companyId, java.lang.String name,
178         java.lang.String description, java.lang.String[] params, int start,
179         int end) throws com.liferay.portal.SystemException {
180         java.util.List<com.liferay.portal.model.Group> returnValue = GroupServiceUtil.search(companyId,
181                 name, description, params, start, end);
182 
183         return GroupJSONSerializer.toJSONArray(returnValue);
184     }
185 
186     public static int searchCount(long companyId, java.lang.String name,
187         java.lang.String description, java.lang.String[] params)
188         throws com.liferay.portal.SystemException {
189         int returnValue = GroupServiceUtil.searchCount(companyId, name,
190                 description, params);
191 
192         return returnValue;
193     }
194 
195     public static void setRoleGroups(long roleId, long[] groupIds)
196         throws com.liferay.portal.PortalException,
197             com.liferay.portal.SystemException {
198         GroupServiceUtil.setRoleGroups(roleId, groupIds);
199     }
200 
201     public static void unsetRoleGroups(long roleId, long[] groupIds)
202         throws com.liferay.portal.PortalException,
203             com.liferay.portal.SystemException {
204         GroupServiceUtil.unsetRoleGroups(roleId, groupIds);
205     }
206 
207     public static JSONObject updateFriendlyURL(long groupId,
208         java.lang.String friendlyURL)
209         throws com.liferay.portal.PortalException,
210             com.liferay.portal.SystemException {
211         com.liferay.portal.model.Group returnValue = GroupServiceUtil.updateFriendlyURL(groupId,
212                 friendlyURL);
213 
214         return GroupJSONSerializer.toJSONObject(returnValue);
215     }
216 
217     public static JSONObject updateGroup(long groupId, java.lang.String name,
218         java.lang.String description, int type, java.lang.String friendlyURL,
219         boolean active)
220         throws com.liferay.portal.PortalException,
221             com.liferay.portal.SystemException {
222         com.liferay.portal.model.Group returnValue = GroupServiceUtil.updateGroup(groupId,
223                 name, description, type, friendlyURL, active);
224 
225         return GroupJSONSerializer.toJSONObject(returnValue);
226     }
227 
228     public static JSONObject updateGroup(long groupId,
229         java.lang.String typeSettings)
230         throws com.liferay.portal.PortalException,
231             com.liferay.portal.SystemException {
232         com.liferay.portal.model.Group returnValue = GroupServiceUtil.updateGroup(groupId,
233                 typeSettings);
234 
235         return GroupJSONSerializer.toJSONObject(returnValue);
236     }
237 
238     public static JSONObject updateWorkflow(long groupId,
239         boolean workflowEnabled, int workflowStages,
240         java.lang.String workflowRoleNames)
241         throws com.liferay.portal.PortalException,
242             com.liferay.portal.SystemException {
243         com.liferay.portal.model.Group returnValue = GroupServiceUtil.updateWorkflow(groupId,
244                 workflowEnabled, workflowStages, workflowRoleNames);
245 
246         return GroupJSONSerializer.toJSONObject(returnValue);
247     }
248 }