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.portlet.messageboards.service.http;
24  
25  import com.liferay.portal.kernel.json.JSONArray;
26  import com.liferay.portal.kernel.json.JSONObject;
27  
28  import com.liferay.portlet.messageboards.service.MBCategoryServiceUtil;
29  
30  /**
31   * <a href="MBCategoryServiceJSON.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.portlet.messageboards.service.MBCategoryServiceUtil</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
50   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
51   * service utility returns a <code>com.liferay.portlet.messageboards.model.MBCategory</code>,
52   * that is translated to a
53   * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
54   * cannot safely use are skipped. The logic for the translation is encapsulated
55   * in <code>com.liferay.portlet.messageboards.service.http.MBCategoryJSONSerializer</code>.
56   * </p>
57   *
58   * <p>
59   * This allows you to call the the backend services directly from JavaScript.
60   * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
61   * reference of how that portlet uses the generated JavaScript in
62   * <code>portal-web/docroot/html/js/service.js</code> to call the backend
63   * services directly from JavaScript.
64   * </p>
65   *
66   * <p>
67   * The JSON utility is only generated for remote services.
68   * </p>
69   *
70   * @author Brian Wing Shun Chan
71   *
72   * @see com.liferay.portlet.messageboards.service.MBCategoryServiceUtil
73   * @see com.liferay.portlet.messageboards.service.http.MBCategoryJSONSerializer
74   *
75   */
76  public class MBCategoryServiceJSON {
77      public static JSONObject addCategory(long plid, long parentCategoryId,
78          java.lang.String name, java.lang.String description,
79          boolean addCommunityPermissions, boolean addGuestPermissions)
80          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
81              com.liferay.portal.SystemException {
82          com.liferay.portlet.messageboards.model.MBCategory returnValue = MBCategoryServiceUtil.addCategory(plid,
83                  parentCategoryId, name, description, addCommunityPermissions,
84                  addGuestPermissions);
85  
86          return MBCategoryJSONSerializer.toJSONObject(returnValue);
87      }
88  
89      public static JSONObject addCategory(long plid, long parentCategoryId,
90          java.lang.String name, java.lang.String description,
91          java.lang.String[] communityPermissions,
92          java.lang.String[] guestPermissions)
93          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
94              com.liferay.portal.SystemException {
95          com.liferay.portlet.messageboards.model.MBCategory returnValue = MBCategoryServiceUtil.addCategory(plid,
96                  parentCategoryId, name, description, communityPermissions,
97                  guestPermissions);
98  
99          return MBCategoryJSONSerializer.toJSONObject(returnValue);
100     }
101 
102     public static void deleteCategory(long categoryId)
103         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
104             com.liferay.portal.SystemException {
105         MBCategoryServiceUtil.deleteCategory(categoryId);
106     }
107 
108     public static JSONObject getCategory(long categoryId)
109         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
110             com.liferay.portal.SystemException {
111         com.liferay.portlet.messageboards.model.MBCategory returnValue = MBCategoryServiceUtil.getCategory(categoryId);
112 
113         return MBCategoryJSONSerializer.toJSONObject(returnValue);
114     }
115 
116     public static JSONArray getCategories(long groupId, long parentCategoryId,
117         int start, int end)
118         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException {
120         java.util.List<com.liferay.portlet.messageboards.model.MBCategory> returnValue =
121             MBCategoryServiceUtil.getCategories(groupId, parentCategoryId,
122                 start, end);
123 
124         return MBCategoryJSONSerializer.toJSONArray(returnValue);
125     }
126 
127     public static int getCategoriesCount(long groupId, long parentCategoryId)
128         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
129         int returnValue = MBCategoryServiceUtil.getCategoriesCount(groupId,
130                 parentCategoryId);
131 
132         return returnValue;
133     }
134 
135     public static void subscribeCategory(long categoryId)
136         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException {
138         MBCategoryServiceUtil.subscribeCategory(categoryId);
139     }
140 
141     public static void unsubscribeCategory(long categoryId)
142         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException {
144         MBCategoryServiceUtil.unsubscribeCategory(categoryId);
145     }
146 
147     public static JSONObject updateCategory(long categoryId,
148         long parentCategoryId, java.lang.String name,
149         java.lang.String description, boolean mergeWithParentCategory)
150         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException {
152         com.liferay.portlet.messageboards.model.MBCategory returnValue = MBCategoryServiceUtil.updateCategory(categoryId,
153                 parentCategoryId, name, description, mergeWithParentCategory);
154 
155         return MBCategoryJSONSerializer.toJSONObject(returnValue);
156     }
157 }