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