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.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 parentCategoryId,
78          java.lang.String name, java.lang.String description,
79          java.lang.String emailAddress, java.lang.String inProtocol,
80          java.lang.String inServerName, int inServerPort, boolean inUseSSL,
81          java.lang.String inUserName, java.lang.String inPassword,
82          int inReadInterval, java.lang.String outEmailAddress,
83          boolean outCustom, java.lang.String outServerName, int outServerPort,
84          boolean outUseSSL, java.lang.String outUserName,
85          java.lang.String outPassword, boolean mailingListActive,
86          com.liferay.portal.service.ServiceContext serviceContext)
87          throws com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException {
89          com.liferay.portlet.messageboards.model.MBCategory returnValue = MBCategoryServiceUtil.addCategory(parentCategoryId,
90                  name, description, emailAddress, inProtocol, inServerName,
91                  inServerPort, inUseSSL, inUserName, inPassword, inReadInterval,
92                  outEmailAddress, outCustom, outServerName, outServerPort,
93                  outUseSSL, outUserName, outPassword, mailingListActive,
94                  serviceContext);
95  
96          return MBCategoryJSONSerializer.toJSONObject(returnValue);
97      }
98  
99      public static void deleteCategory(long categoryId)
100         throws com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException {
102         MBCategoryServiceUtil.deleteCategory(categoryId);
103     }
104 
105     public static JSONObject getCategory(long categoryId)
106         throws 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 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 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 com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException {
135         MBCategoryServiceUtil.subscribeCategory(categoryId);
136     }
137 
138     public static void unsubscribeCategory(long categoryId)
139         throws 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, java.lang.String emailAddress,
147         java.lang.String inProtocol, java.lang.String inServerName,
148         int inServerPort, boolean inUseSSL, java.lang.String inUserName,
149         java.lang.String inPassword, int inReadInterval,
150         java.lang.String outEmailAddress, boolean outCustom,
151         java.lang.String outServerName, int outServerPort, boolean outUseSSL,
152         java.lang.String outUserName, java.lang.String outPassword,
153         boolean mailingListActive, boolean mergeWithParentCategory)
154         throws com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException {
156         com.liferay.portlet.messageboards.model.MBCategory returnValue = MBCategoryServiceUtil.updateCategory(categoryId,
157                 parentCategoryId, name, description, emailAddress, inProtocol,
158                 inServerName, inServerPort, inUseSSL, inUserName, inPassword,
159                 inReadInterval, outEmailAddress, outCustom, outServerName,
160                 outServerPort, outUseSSL, outUserName, outPassword,
161                 mailingListActive, mergeWithParentCategory);
162 
163         return MBCategoryJSONSerializer.toJSONObject(returnValue);
164     }
165 }