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